se.entra.phantom.common

Interface MouseInterface

All Known Implementing Classes:

TerminalMouseHandler

public interface MouseInterface

Interface to be implemented by mouse movement "hooks" (i.e. classes that handle mouse movements on the server side.)

Author:

Mikael Andersson

Method Summary

Modifier and Type	Method and Description
boolean	closeProject() Close the current application.
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.
Rectangle	getMark() Get the current mark.
int	getMode() Get the current mode.
void	handleMouseEvent(MouseEvent e) Handle the current mouse event.
void	initialize() Perform any necessary initialization.
boolean	isCloseProjectAllowed() Is close application allowed at this point?
boolean	isSaveNeeded() Is save needed at this point?
void	paint(Graphics graphics, TerminalWindow tw, int leftMargin, int topMargin, int cxFont, int cyFont) Paint all defined marks.
boolean	performAction() Perform action.
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 host data.
void	setDimensions(int cxFont, int cyFont, int xOffset, int yOffset, int cxScreen, int cyScreen) Set the dimensions of the component.
void	setHostConnected(boolean connected) Indicate the host session is connected/disconnected.
void	setMainPanel(Object output) Set main panel reference.
void	setMenuItemEnabled(String id, boolean enabled) Set menu alternative enabled (or inactive)
void	setMode(int mode) Set the mode the terminal is running in.
void	setTerminalWindow(TerminalWindow owner) Set the owner of the handler.
boolean	undoAction() Perform undo action.
void	updateMenus() Set the mode indicator in the menus.

Method Detail

handleMouseEvent

void handleMouseEvent(MouseEvent e)

Handle the current mouse event.

Parameters:

e - The MouseEvent.

isCloseProjectAllowed

boolean isCloseProjectAllowed()

Is close application allowed at this point?

Returns:

boolean

closeProject

boolean closeProject()

Close the current application.

Returns:

boolean

displayInputFields

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.

Parameters:

create - should the displayed fields be created.

deleteAllMarks

void deleteAllMarks()

Delete all marks defined for the current screen.

initialize

void initialize()

Perform any necessary initialization.

paint

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

Paint all defined marks.

Parameters:

graphics - The graphics.

tw - Terminal window.

leftMargin - Left margin.

topMargin - Top margin.

cxFont - Font height.

cyFont - Font width.

getMark

Rectangle getMark()

Get the current mark.

Returns:

Rectangle

getBackground

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

Gets the background color when drawing a character.

Returns:

The color to use or null for default background color.

getMode

int getMode()

Get the current mode.

Returns:

int

setDimensions

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

Set the dimensions of the component.

Parameters:

cxFont - horizontal font size

cyFont - vertical font size

xOffset - horizontal offset

yOffset - vertical offset

cxScreen - screen width

cyScreen - screen height

isSaveNeeded

boolean isSaveNeeded()

Is save needed at this point?

Returns:

boolean

removeMark

void removeMark()

Removes the current mark.

removeExcludedPopup

void removeExcludedPopup()

Perform remove excluded pop-up window action.

setMainPanel

void setMainPanel(Object output)

Set main panel reference.

Parameters:

output - The main panel reference.

saveHostData

boolean saveHostData()

Save the host data.

Returns:

true if successful, false for failure or canceled.

setMode

void setMode(int mode)

Set the mode the terminal is running in.

Parameters:

mode -

setTerminalWindow

void setTerminalWindow(TerminalWindow owner)

Set the owner of the handler.

Parameters:

owner - The terminal window owner.

updateMenus

void updateMenus()

Set the mode indicator in the menus.

performAction

boolean performAction()

Perform action.

Returns:

boolean - true if successful

undoAction

boolean undoAction()

Perform undo action.

Returns:

boolean - true if successful

setHostConnected

void setHostConnected(boolean connected)

Indicate the host session is connected/disconnected.

Parameters:

connected - Connection flag.

setMenuItemEnabled

void setMenuItemEnabled(String id,
                        boolean enabled)

Set menu alternative enabled (or inactive)

Parameters:

id - menu item ID

enabled - true = active, false = inactive

rematchScreen

void rematchScreen(boolean reset)

Performs a re-match of the current screen.

Parameters:

reset - is it allowed to reset the current screen?