se.entra.phantom.server.phed

Class TerminalMouseHandler

java.lang.Object

se.entra.phantom.server.phed.TerminalMouseHandler

All Implemented Interfaces:

MouseInterface, EditorDirectInterface

public class TerminalMouseHandler
extends Object
implements MouseInterface, EditorDirectInterface

The class handling the terminal part of the Editor.

Author:

Mikael Andersson

Field Summary

Fields

Modifier and Type	Field and Description
static int	MODE_EDITOR

Constructor Summary

Constructors

Constructor and Description
TerminalMouseHandler() Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	closeProject() Close the current application.
boolean	closeProjectDirect() Close the current application without asking for save etc.
void	deleteAllMarks() Delete all marks defined for the current screen.
void	displayInputFields(boolean create) Display all input fields in the current host screen.
Color	getBackground(Color background, int x, int y) Gets the background color when drawing a character.
HostPopupWindow.Rect	getConstrainingPopup() Get the constraining popup.
se.entra.phantom.server.phed.FieldDecoratedMark	getLastField(se.entra.phantom.server.phed.FieldDecoratedMark current) Get the last host field that is not equal to the indicated one.
se.entra.phantom.server.phed.FieldDecoratedMark	getLastNormalField(se.entra.phantom.server.phed.FieldDecoratedMark current) Get the last defined host field that is not a continued field and is different from the indicated one.
Rectangle	getMark() Get the current mark's rectangle representation.
se.entra.phantom.server.phed.DecoratedMarks	getMarks() Get the marks container.
int	getMode() Get the current mode.
String	getNewFieldName() Get a new field name.
PhantomHostScreen	getPhantomHostScreen() Get the phantom host screen.
void	handleMouseEvent(MouseEvent event) Handle the current mouse event.
boolean	inEditingMode() Checks if the mode is in an editing mode, i.e.
void	initialize() Perform any necessary initialization.
boolean	isCloseProjectAllowed() Is close application allowed at this point?
boolean	isEdited() Is this phantom host screen edited.
boolean	isSaveNeeded() Is save needed at this point?
int	messageBox(int type, int icon, String message, String title) Display a message box.
void	paint(Graphics graphics, TerminalWindow tw, int leftMargin, int topMargin, int cxFont, int cyFont) Paint all defined marks.
boolean	performAction() Perform action.
void	populateMarks(PhantomHostScreen screen) Read the existing screen definition and populate the mark container.
void	populateMarksDirect(PhantomHostScreen screen) Read the screen definition and populate the mark container directly (i.e.
void	rematchScreen(boolean reset) Performs a re-match of the current screen.
void	removeExcludedPopup() Perform remove excluded pop-up window action.
void	removeMark() Removes the current mark.
boolean	saveHostData() Save the PhantomHostData structure to file.
boolean	saveScreenDefinitionDirect() Save the screen definition in the PhantomHostData structure.
boolean	setConstrainedDirect(HostPopupWindow.Rect constraint) Set whether the window should be constrained (i.e.
void	setCurrentMark(se.entra.phantom.server.phed.DecoratedMark newMark) Sets the current mark.
boolean	setCurrentScreenDirect(PhantomHostScreen newScreen) Set the current screen programmatically.
void	setDimensions(int cxFont, int cyFont, int xOffset, int yOffset, int cxScreen, int cyScreen) Set the dimensions of the component.
void	setEdited(boolean edited) Set the phantom host screen as edited.
void	setHostConnected(boolean connected) Indicate the host session is connected/disconnected.
void	setMainPanel(Object main) Set main panel reference.
void	setMenuItemEnabled(String id, boolean enabled) Set menu item as enabled (or disabled).
void	setMode(int newMode) Set the mode the terminal is running in.
boolean	setModeDirect(int newMode) Set the current mode directly (i.e.
void	setSessionManager(VirtualSessionManager vsm) Set the virtual session manager reference.
void	setTerminalWindow(TerminalWindow owner) Set the owner of the handler.
boolean	undoAction() Perform undo action.
void	update(HostScreen hs) Set the host fields.
void	updateMenus() Set the mode indicator in the menus.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MODE_EDITOR

public static final int MODE_EDITOR

See Also:

Constant Field Values

Constructor Detail

TerminalMouseHandler

public TerminalMouseHandler()

Constructor.

Method Detail

displayInputFields

public void displayInputFields(boolean create)

Display all input fields in the current host screen. Optionally, also create the displayed fields. This means generating name and defining the fields as defined.

Specified by:

displayInputFields in interface MouseInterface

Parameters:

create - Flag if the displayed fields should be created or not.

deleteAllMarks

public void deleteAllMarks()

Delete all marks defined for the current screen.

Specified by:

deleteAllMarks in interface MouseInterface

rematchScreen

public void rematchScreen(boolean reset)

Performs a re-match of the current screen.

Specified by:

rematchScreen in interface MouseInterface

Parameters:

reset - Flag to perform a re-match of the current screen or not.

getMark

public Rectangle getMark()

Get the current mark's rectangle representation.

Specified by:

getMark in interface MouseInterface

Returns:

Rectangle

getMarks

public se.entra.phantom.server.phed.DecoratedMarks getMarks()

Get the marks container.

Specified by:

getMarks in interface EditorDirectInterface

Returns:

DecoratedMarks

setCurrentMark

public void setCurrentMark(se.entra.phantom.server.phed.DecoratedMark newMark)

Sets the current mark.

Specified by:

setCurrentMark in interface EditorDirectInterface

Parameters:

newMark - The new DecoratedMark to set.

getMode

public int getMode()

Get the current mode.

Specified by:

getMode in interface MouseInterface

Returns:

int

closeProjectDirect

public boolean closeProjectDirect()

Close the current application without asking for save etc.

Specified by:

closeProjectDirect in interface EditorDirectInterface

Returns:

boolean

closeProject

public boolean closeProject()

Close the current application.

Specified by:

closeProject in interface MouseInterface

Returns:

boolean

messageBox

public int messageBox(int type,
                      int icon,
                      String message,
                      String title)

Display a message box.

Specified by:

messageBox in interface EditorDirectInterface

Parameters:

type -

icon -

message -

title -

Returns:

The return code, -1 for close.

removeMark

public void removeMark()

Removes the current mark.

Specified by:

removeMark in interface MouseInterface

getLastNormalField

public se.entra.phantom.server.phed.FieldDecoratedMark getLastNormalField(se.entra.phantom.server.phed.FieldDecoratedMark current)

Get the last defined host field that is not a continued field and is different from the indicated one.

Specified by:

getLastNormalField in interface EditorDirectInterface

Parameters:

current - The current FieldDecoratedMark, null for none.

Returns:

FieldDecoratedMark or null if not found.

getLastField

public se.entra.phantom.server.phed.FieldDecoratedMark getLastField(se.entra.phantom.server.phed.FieldDecoratedMark current)

Get the last host field that is not equal to the indicated one.

Specified by:

getLastField in interface EditorDirectInterface

Parameters:

current - The current FieldDecoratedMark, null for none.

Returns:

FieldDecoratedMark or null if not found.

getPhantomHostScreen

public PhantomHostScreen getPhantomHostScreen()

Get the phantom host screen.

Specified by:

getPhantomHostScreen in interface EditorDirectInterface

Returns:

PhantomHostScreen

populateMarks

public void populateMarks(PhantomHostScreen screen)

Read the existing screen definition and populate the mark container.

Specified by:

populateMarks in interface EditorDirectInterface

Parameters:

screen - The PhantomHostScreen.

populateMarksDirect

public void populateMarksDirect(PhantomHostScreen screen)

Read the screen definition and populate the mark container directly (i.e. programmatically - without displaying pop-ups, etc and not based on the underlying host screen). Base offset of marks on the current constraining rectangle.

Specified by:

populateMarksDirect in interface EditorDirectInterface

Parameters:

screen - The PhantomHostScreen.

removeExcludedPopup

public void removeExcludedPopup()

Perform remove excluded pop-up window action.

Specified by:

removeExcludedPopup in interface MouseInterface

saveScreenDefinitionDirect

public boolean saveScreenDefinitionDirect()

Save the screen definition in the PhantomHostData structure.

Specified by:

saveScreenDefinitionDirect in interface EditorDirectInterface

Returns:

boolean - true if successful

saveHostData

public boolean saveHostData()

Save the PhantomHostData structure to file.

Specified by:

saveHostData in interface MouseInterface

Returns:

boolean - true if successful, false otherwise, typically when user canceled the save message box.

isSaveNeeded

public boolean isSaveNeeded()

Is save needed at this point?

Specified by:

isSaveNeeded in interface MouseInterface

Returns:

boolean

inEditingMode

public boolean inEditingMode()

Checks if the mode is in an editing mode, i.e. in edit-field/screenID modes.

isCloseProjectAllowed

public boolean isCloseProjectAllowed()

Is close application allowed at this point?

Specified by:

isCloseProjectAllowed in interface MouseInterface

Returns:

boolean

handleMouseEvent

public void handleMouseEvent(MouseEvent event)

Description copied from interface: MouseInterface

Handle the current mouse event.

Specified by:

handleMouseEvent in interface MouseInterface

Parameters:

event - The MouseEvent.

setMainPanel

public void setMainPanel(Object main)

Description copied from interface: MouseInterface

Set main panel reference.

Specified by:

setMainPanel in interface MouseInterface

Parameters:

main - The main panel reference.

setConstrainedDirect

public boolean setConstrainedDirect(HostPopupWindow.Rect constraint)

Set whether the window should be constrained (i.e. programmatically - without displaying pop-ups, etc.).

Specified by:

setConstrainedDirect in interface EditorDirectInterface

Parameters:

constraint - The pop-up window constrains rectangle, null for none.

Returns:

true, always.

getBackground

public Color getBackground(Color background,
                           int x,
                           int y)

Gets the background color when drawing a character.

Specified by:

getBackground in interface MouseInterface

Parameters:

background - The background color.

x - The X position.

y - The Y position.

Returns:

The color (perhaps mixed) to use or null for default background color.

getConstrainingPopup

public HostPopupWindow.Rect getConstrainingPopup()

Get the constraining popup.

Specified by:

getConstrainingPopup in interface EditorDirectInterface

Returns:

HostPopupWindow.Rect, the constraining popup rectangle, null for none.

isEdited

public boolean isEdited()

Is this phantom host screen edited.

Specified by:

isEdited in interface EditorDirectInterface

Returns:

boolean Returns if the PhantomHostScreen has been edited or not.

setEdited

public void setEdited(boolean edited)

Set the phantom host screen as edited.

Specified by:

setEdited in interface EditorDirectInterface

Parameters:

edited - Flag for PhantomHostScreen edited or not.

setDimensions

public void setDimensions(int cxFont,
                          int cyFont,
                          int xOffset,
                          int yOffset,
                          int cxScreen,
                          int cyScreen)

Set the dimensions of the component.

Specified by:

setDimensions in interface MouseInterface

Parameters:

cxFont - horizontal font size

cyFont - vertical font size

xOffset - horizontal offset

yOffset - vertical offset

cxScreen - horizontal screen size

cyScreen - vertical screen size

setSessionManager

public void setSessionManager(VirtualSessionManager vsm)

Set the virtual session manager reference.

Parameters:

vsm - The VirtualSessionManager.

setTerminalWindow

public void setTerminalWindow(TerminalWindow owner)

Set the owner of the handler.

Specified by:

setTerminalWindow in interface MouseInterface

Parameters:

owner - The owner TerminalWindow.

setCurrentScreenDirect

public boolean setCurrentScreenDirect(PhantomHostScreen newScreen)

Set the current screen programmatically.

Specified by:

setCurrentScreenDirect in interface EditorDirectInterface

Parameters:

newScreen - The new PhantomHostScreen.

Returns:

boolean true for success, always.

getNewFieldName

public String getNewFieldName()

Get a new field name.

Specified by:

getNewFieldName in interface EditorDirectInterface

Returns:

String - a newly generated, and unique field name

setHostConnected

public void setHostConnected(boolean connected)

Indicate the host session is connected/disconnected.

Specified by:

setHostConnected in interface MouseInterface

Parameters:

connected - The connected-enabled state.

paint

public void paint(Graphics graphics,
                  TerminalWindow tw,
                  int leftMargin,
                  int topMargin,
                  int cxFont,
                  int cyFont)

Paint all defined marks.

Specified by:

paint in interface MouseInterface

Parameters:

graphics - The Graphics.

tw - The TerminalWindow.

leftMargin - Left margin.

topMargin - Top margin.

cxFont - Font width.

cyFont - Font height.

updateMenus

public void updateMenus()

Set the mode indicator in the menus.

Specified by:

updateMenus in interface MouseInterface

setMenuItemEnabled

public void setMenuItemEnabled(String id,
                               boolean enabled)

Set menu item as enabled (or disabled).

Specified by:

setMenuItemEnabled in interface MouseInterface

Parameters:

id - The menu item ID.

enabled - true = enabled, false = disabled.

setMode

public void setMode(int newMode)

Set the mode the terminal is running in.

Specified by:

setMode in interface MouseInterface

Parameters:

newMode - The new mode.

setModeDirect

public boolean setModeDirect(int newMode)

Set the current mode directly (i.e. programmatically - without displaying pop-ups, etc.) The action is either successful (and returns true) or not in its entirety. This action is atomic. Note: This method should not be called to implicitly create a new PhantomHostScreen. This will fail!

Specified by:

setModeDirect in interface EditorDirectInterface

Parameters:

newMode - The new mode.

Returns:

boolean - true for success, false for failure.

initialize

public void initialize()

Perform any necessary initialization.

Specified by:

initialize in interface MouseInterface

performAction

public boolean performAction()

Perform action.

Specified by:

performAction in interface MouseInterface

Returns:

boolean - true if successful

undoAction

public boolean undoAction()

Perform undo action.

Specified by:

undoAction in interface MouseInterface

Returns:

boolean - true if successful

update

public void update(HostScreen hs)

Set the host fields.

Parameters:

hs - The host screen.