se.entra.phantom.server

Class VirtualCNoteBook

java.lang.Object

se.entra.phantom.server.VirtualControl

se.entra.phantom.server.VirtualCNoteBook

All Implemented Interfaces:

NetPhantomConstants, PhantomControlType, VirtualChangeEvent, VirtualClientMessages, VirtualInterface, VirtualTooltipInterface

public class VirtualCNoteBook
extends VirtualControl

Field Summary

Fields inherited from interface se.entra.phantom.server.PhantomControlType

CTRLTYPE_BUTTON, CTRLTYPE_CHECK, CTRLTYPE_COMBO, CTRLTYPE_FRAME, CTRLTYPE_GRAPH, CTRLTYPE_GROUP, CTRLTYPE_INOUT, CTRLTYPE_LIST, CTRLTYPE_MLE, CTRLTYPE_NOTE, CTRLTYPE_OUT, CTRLTYPE_RADIO, CTRLTYPE_RECT, CTRLTYPE_SPIN, CTRLTYPE_SUB, CTRLTYPE_TEXT, CTRLTYPE_TREE, CTRLTYPE_UNKNOWN, CTRLTYPE_USER, CTRLTYPES_COUNT, names

Fields inherited from interface se.entra.phantom.server.VirtualInterface

TOOLTIP_TEXT

Fields inherited from interface se.entra.phantom.common.NetPhantomConstants

ACTION_CLOSEWINDOW, ACTION_CONTROL, ACTION_HOSTKEY, ACTION_MENU, ACTION_NONE, ACTION_NOTEBOOKPAGE, ACTION_POPUPMENU, CC_BACKGROUND, CC_BOTH, CC_FOREGROUND, CC_NONE, CLIPBOARD_GET, CLIPBOARD_SET, DATEF_DMY, DATEF_MDY, DATEF_SYSTEM, DATEF_YMD, DDE_ADVISE, DDE_EXECUTE, DDE_INITIATE, DDE_POKE, DDE_REQUEST, DDE_TERMINATE, DDE_UNADVISE, DDE_UPDATE, DDEVAR_DISABLE, DDEVAR_ENABLE, DDEVAR_REQUEST, DDEVAR_SET, DDEVAR_VALIDATE, EFT_AMOUNT, EFT_DATE, EFT_DATEAMOUNT, EFT_NORMAL, EFT_PASSWORD, EVENT_CHAR, EVENT_CHECK, EVENT_CLICK, EVENT_COMMAND, EVENT_DBLCLICK, EVENT_DDECONNECTION, EVENT_DDEDATA, EVENT_DDEERROR, EVENT_DDEEXECUTE, EVENT_DDEINVALIDATE, EVENT_DDEPOKE, EVENT_DDEREQUEST, EVENT_DEFOCUS, EVENT_FOCUS, EVENT_PAGEDOWN, EVENT_PAGEUP, EVENT_SELECT, EVENT_UNKNOWN, EVENT_USERCHANGE, EXTENDEDINFO_IDS_TO_CLIENT, FOCUSTYPE_CLIENTTARGET, FOCUSTYPE_CONTROL, FOCUSTYPE_NONE, ICON_CRITICAL, ICON_INFORMATION, ICON_NOICON, ICON_QUERY, ICON_WARNING, J_AUTO, J_BOTTOM, J_BOTTOMLEFT, J_BOTTOMRIGHT, J_CENTER, J_LEFT, J_RIGHT, J_TOP, J_TOPLEFT, J_TOPRIGHT, MAX_PANELS_PER_SESSION, MAX_SESSIONS, MB_ABORTRETRYIGNORE, MB_CANCEL, MB_ENTER, MB_ENTERCANCEL, MB_OK, MB_OKCANCEL, MB_RETRYCANCEL, MB_YESNO, MB_YESNOCANCEL, MBID_CANCEL, MBID_DEFAULT, MBID_ENTER, MBID_IGNORE, MBID_NO, MBID_OK, MBID_RETRY, MBID_YES, MS_MOVE, MS_NONE, MS_SIZE, NETPHANTOM_COPYRIGHT, NETPHANTOM_COPYRIGHT2, NETPHANTOM_VERSION, OBJEVENT_CHECK, OBJEVENT_CLICK, OBJEVENT_DBLCLICK, OBJEVENT_DEFOCUS, OBJEVENT_FOCUS, OBJEVENT_SELECT, OBJEVENT_USERCHANGE, PANELCREATE_APPPANEL, PANELCREATE_DANGLINGPANEL, PANELCREATE_DLGFRAME, PANELCREATE_EXTENDEDINFO, PANELCREATE_ICON, PANELCREATE_INDIVIDUALSIZE, PANELCREATE_POPUP, REPLYTYPE_CLIENTEXECUTE, REPLYTYPE_CLIPBOARD, REPLYTYPE_DDE, REPLYTYPE_FFONTLIST, REPLYTYPE_MESSAGEBOX, REPLYTYPE_REPORT, REPLYTYPE_SAVEPROPS, REPLYTYPE_TERMMARK, RPRT_CANCELPRINTJOB, RPRT_CLOSEPRINTJOB, RPRT_CONTPRINTJOB, RPRT_OPENPRINTJOB, RPRT_PRINTJOBCANCLD, RPRT_PRINTJOBCLOSED, RPRT_PRINTJOBCONT, RPRT_PRINTJOBOPENED, RPRT_PRINTJOBSTARTED, RPRT_STARTPRINTJOB, SELMODE_NORMAL, SELMODE_NOTALLOWED, SELMODE_REQUIRED, SELTYPE_MULTIPLE, SELTYPE_SINGLE, SEPARATOR, SEPARATORCHAR, TRANS_APPLICATIONCHANGE, TRANS_CALLOBJECT, TRANS_CANCELEXIT, TRANS_CLEARLOCK, TRANS_CLIENTEXECUTE, TRANS_CLIENTJARS, TRANS_CLIENTTEXTTABLE, TRANS_CLIENTUPDATED, TRANS_CLIENTUPDATEDNOLOCK, TRANS_CLIPBOARD, TRANS_CLIPBOARDCOMPONENT, TRANS_CLOSETERMINALWINDOW, TRANS_CONNECTIONREFUSED, TRANS_COUNTRYINFO, TRANS_CREATEPANEL, TRANS_CREATESESSION, TRANS_DDE, TRANS_DDEEVENT, TRANS_DDEEVENTREPLY, TRANS_DDEVAREVENT, TRANS_DISPLAYHELP, TRANS_DISPLAYTERMINAL, TRANS_DISPLAYTOOLTIPS, TRANS_ENDCONVERSATION, TRANS_EXIT, TRANS_FONTSUBSTITUTION, TRANS_HOSTCOLORTABLE, TRANS_HOSTPRINT, TRANS_HWND, TRANS_INACTIVESESSION, TRANS_INITIATE, TRANS_KEEPALIVE, TRANS_LOCALE, TRANS_LOGEVENT, TRANS_MESSAGEBOX, TRANS_MESSAGEBOXWITHREPLY, TRANS_MODALREPLY, TRANS_MULTTERM, TRANS_PING, TRANS_PRINTCOMPONENT, TRANS_PRINTPANEL, TRANS_PRINTREPORT, TRANS_PRTWINKEY, TRANS_RECONNECT, TRANS_REDIRECTION, TRANS_REMOVEPANELATLEVEL, TRANS_REMOVETERMINAL, TRANS_RENEGOTIATESSL, TRANS_REQUESTHELP, TRANS_RESOURCEURL, TRANS_SELECTSESSION, TRANS_SESSIONACTIVE, TRANS_SESSIONSELECTED, TRANS_SETCOLORS, TRANS_SETFOCUS, TRANS_SETLOCK, TRANS_SETPANELNESTLEVEL, TRANS_SETUPPARAMS, TRANS_SHOWDOCUMENT, TRANS_SOCKET, TRANS_SOUNDALARM, TRANS_STARTUPINFO, TRANS_STOPSESSION, TRANS_TERMINALDATA, TRANS_TERMINALUPDATE, TRANS_TERMINALWINDOW, TRANS_TERMWINTEXT, TRANS_UPDATEAPPLICATION, TRANS_UPDATEPANEL, TRANS_USEREXITPRTKEY, TRANSACTION_VERSION, TS_CLOSE, TS_DATA, TS_ERROR, TS_OPEN, VSIGN_MINUS, VSIGN_NONE, VSIGN_PLUSMINUS, YEARF_6DIG, YEARF_8DIG, YEARF_EXP8

Constructor Summary

Constructors

Constructor and Description
VirtualCNoteBook(VirtualPanel panel, PhantomCNoteBook data) The constructor of the control always calls the superclass.

Method Summary

Modifier and Type	Method and Description
boolean	areTextPromptsAlwaysRefreshed() If the class has a need to refresh the text prompt at all host changed, it must reply true to this method call.
void	clientUpdated(Transaction trans) This method is called from the VirtualPanel to cause a client transaction to update the panels.
void	dispose() This method is called whenever a panel has been disposed of, in order to remove listeners, etc, in order to free up memory.
boolean	doCurrentScreenMatch(PhantomHostScreen screen) Is current page connected to specified (current) screen.
boolean	doPreloadPages() Do preload notebook pages.
void	fireCreate(Transaction trans) This method fires the creation data transaction to the client.
void	fireHostMessageBoxes() Fires host message boxes to the client for the current page.
void	fireUpdate(Transaction trans) This method is used to fire an update message to the client by a virtual class.
void	forceHostChange(ClientSessionInterface clientSession) Force a host change.
VirtualControl	getControlConnectedToHost(PhantomHostScreen screen, PhantomHostField hostField, int flags) Check if control is connected to host field.
VirtualInterface	getControlFromID(String panelID, String ctrlMenuID) Search for control or menu in all notebook pages.
int	getCurrentPage() Method to access the current active Notebook page index.
int	getPageCount() Return number of pages/panels in notebook.
String	getPageID(int page) Method to access the page ID from page index.
VirtualPanel	getPagePanel(int index) Gets the panel for the specific page index.
VirtualPanel	getPagePanel(String pageID) Gets the panel ID page.
VirtualControl	getSelectableControl(int flags) Check if any control in the current page can receive focus (is selectable).
void	issueAction(Transaction trans) This method is invoked by the server kernel whenever a push button has been pressed on the client side.
void	issuePageChange(Transaction trans) Client has requested a notebook page change.
void	issuePaging() Perform next/previous action in notebook paging.
void	refresh() This method is used to refresh all virtual controls when e.g.
void	refreshTextPrompts(boolean alwaysRefresh) This method is used to refresh all virtual classes that have text prompt data in them.
void	resetHostMessageBoxes() This method calls the reset method in the VirtualHostMessageBox classes of this panel because new message boxes needs to be displayed.
boolean	setFocus() Sets the focus to this control.
void	startPaging(int destPage) Start paging by setting destination page and VirtualPanelSession paging reference.
void	stopPaging(boolean clearLock) Stop/cancel paging.
void	turnToPage(int setPage) This method is called when the server wants to turn/set notebook page.
void	turnToPage(String pagePanelID) This method is called when the server wants to turn/set notebook page.

Methods inherited from class se.entra.phantom.server.VirtualControl

appendCreateTransaction, appendFieldCheckTransaction, appendFontTransaction, appendUpdateTransaction, callControl, callObject, callObject, deleteAll, deleteLine, getBackgroundColor, getBasicData, getCell, getClientSession, getColor, getComponentLockObject, getControlID, getControlIDHostFieldID, getControlType, getCurrentHostSession, getExtraUpdateFlags, getFont, getForegroundColor, getHostField, getID, getIndex, getLength, getLine, getLineCount, getNextSelection, getObject, getPanel, getPreviousConnectedControl, getProperty, getText, getTextData, getTooltipText, getVirtualSessionManager, hasChanged, hostScreenChanged, insertLine, isChecked, isConnectToNextControlPropertySet, isDirectChecked, isEnabled, isNewGroup, issueControlAction, isTabSkipped, isVisible, parseRuntimeFont, refreshTextPrompts, requestFocus, selectField, setBackgroundColor, setCell, setChanged, setChecked, setColor, setEnabled, setFileFromList, setFocus, setFont, setForegroundColor, setLength, setLine, setListFromFile, setProperty, setSelection, setText, setTooltipText, setupControlIDObject, setVirtualText, setVisible, textFileChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

VirtualCNoteBook

public VirtualCNoteBook(VirtualPanel panel,
                        PhantomCNoteBook data)

The constructor of the control always calls the superclass.

Method Detail

dispose

public void dispose()

This method is called whenever a panel has been disposed of, in order to remove listeners, etc, in order to free up memory.

Overrides:

dispose in class VirtualControl

refresh

public void refresh()

This method is used to refresh all virtual controls when e.g. a new panel is created or when any host change occurs.

Specified by:

refresh in interface VirtualClientMessages

Overrides:

refresh in class VirtualControl

refreshTextPrompts

public void refreshTextPrompts(boolean alwaysRefresh)

This method is used to refresh all virtual classes that have text prompt data in them. The parameter mustRefresh is set when the panel is created or recreated. If the class has a need to refresh the text prompt at all host changed, it must reply true to the method call areTextPromptsAlwaysRefreshed.

Overrides:

refreshTextPrompts in class VirtualControl

areTextPromptsAlwaysRefreshed

public boolean areTextPromptsAlwaysRefreshed()

If the class has a need to refresh the text prompt at all host changed, it must reply true to this method call. Otherwise return false.

Specified by:

areTextPromptsAlwaysRefreshed in interface VirtualClientMessages

Overrides:

areTextPromptsAlwaysRefreshed in class VirtualControl

Returns:

true always call refreshTextPrompts at every host change.

doPreloadPages

public boolean doPreloadPages()

Do preload notebook pages.

fireCreate

public void fireCreate(Transaction trans)

This method fires the creation data transaction to the client. The first thing must be to call the superclass.

Specified by:

fireCreate in interface VirtualClientMessages

Overrides:

fireCreate in class VirtualControl

fireUpdate

public void fireUpdate(Transaction trans)

This method is used to fire an update message to the client by a virtual class.

Specified by:

fireUpdate in interface VirtualClientMessages

Overrides:

fireUpdate in class VirtualControl

clientUpdated

public void clientUpdated(Transaction trans)

This method is called from the VirtualPanel to cause a client transaction to update the panels.

Specified by:

clientUpdated in class VirtualControl

Parameters:

trans - A transaction that is already being processed.

issueAction

public void issueAction(Transaction trans)

This method is invoked by the server kernel whenever a push button has been pressed on the client side. Every updateable control (in the VirtualNnnn classes) are set to reflect the changes made on the client side.

Specified by:

issueAction in class VirtualControl

Parameters:

trans - A transaction that is already being processed.

issuePageChange

public void issuePageChange(Transaction trans)

Client has requested a notebook page change.

issuePaging

public void issuePaging()

Perform next/previous action in notebook paging. Loop until host locked, error or when at destination. This method is called both at paging start and when host change.

See Also:

issuePageChange(se.entra.phantom.common.Transaction)

forceHostChange

public void forceHostChange(ClientSessionInterface clientSession)

Force a host change.

startPaging

public void startPaging(int destPage)

Start paging by setting destination page and VirtualPanelSession paging reference.

stopPaging

public void stopPaging(boolean clearLock)

Stop/cancel paging.

turnToPage

public void turnToPage(String pagePanelID)

This method is called when the server wants to turn/set notebook page. This happens when the host screen or cursor has changed. The client is notified if the page has changed.

turnToPage

public void turnToPage(int setPage)

This method is called when the server wants to turn/set notebook page. This happens when the host screen or cursor has changed. The client is notified if the page has changed.

getPageCount

public int getPageCount()

Return number of pages/panels in notebook.

getPageID

public String getPageID(int page)

Method to access the page ID from page index.

getCurrentPage

public int getCurrentPage()

Method to access the current active Notebook page index.

getControlFromID

public VirtualInterface getControlFromID(String panelID,
                                         String ctrlMenuID)

Search for control or menu in all notebook pages.

Returns:

VirtualInterface, or null if not found.

doCurrentScreenMatch

public boolean doCurrentScreenMatch(PhantomHostScreen screen)

Is current page connected to specified (current) screen.

getControlConnectedToHost

public VirtualControl getControlConnectedToHost(PhantomHostScreen screen,
                                                PhantomHostField hostField,
                                                int flags)

Check if control is connected to host field. This method is overwritten from VirtualControl.

Overrides:

getControlConnectedToHost in class VirtualControl

Returns:

VirtualControl if connected, othervise null if not connected.

getSelectableControl

public VirtualControl getSelectableControl(int flags)

Check if any control in the current page can receive focus (is selectable). This method is overwritten from VirtualControl.

Overrides:

getSelectableControl in class VirtualControl

Returns:

VirtualControl if selectable, othervise null.

setFocus

public boolean setFocus()

Sets the focus to this control.

Specified by:

setFocus in interface VirtualInterface

Overrides:

setFocus in class VirtualControl

Returns:

false for failure.

getPagePanel

public VirtualPanel getPagePanel(int index)

Gets the panel for the specific page index.

Returns:

null if page index is wrong.

getPagePanel

public VirtualPanel getPagePanel(String pageID)

Gets the panel ID page.

Returns:

null if page ID does not exist.

fireHostMessageBoxes

public void fireHostMessageBoxes()

Fires host message boxes to the client for the current page.

resetHostMessageBoxes

public void resetHostMessageBoxes()

This method calls the reset method in the VirtualHostMessageBox classes of this panel because new message boxes needs to be displayed.