se.entra.phantom.server

Class VirtualCTree

java.lang.Object

se.entra.phantom.server.VirtualControl

se.entra.phantom.server.VirtualCTree

All Implemented Interfaces:

NetPhantomConstants, PhantomControlType, VirtualChangeEvent, VirtualClientMessages, VirtualInterface, VirtualTooltipInterface

public class VirtualCTree
extends VirtualControl

The tree control on the server side. Tree nodes are manipulated on the instance in question of the VirtualCTreeNode. Support methods are present in the this class as well as in VirtualCTreeNode.

Author:

Christopher Mindus

Field Summary

Fields

Modifier and Type	Field and Description
static int	DOUBLE_CLICK_EVENT The double-click event.
static int	FLAG_BORDER
static int	FLAG_DBLCLK
static int	FLAG_HORZ
static int	FLAG_SELECT_MASK Tree flags, same as on server.
static int	FLAG_SELECT_MULTI_CONT
static int	FLAG_SELECT_MULTI_DISCONT
static int	FLAG_SELECT_SINGLE
static int	FLAG_SHOW_ROOT
static int	FLAG_SHOW_ROOT_HANDLES
static int	FLAG_VERT
static int	SELECTION_EVENT The selection event.

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
VirtualCTree(VirtualPanel panel, PhantomCTree data) The constructor of the control always calls the superclass.

Method Summary

Modifier and Type	Method and Description
void	clientUpdated(Transaction trans) This method is called from the VirtualPanel to cause a client transaction to update the panels.
boolean	collapse(VirtualCTreeNode node) Collapses a node.
boolean	collapseAll(VirtualCTreeNode node) Collapse this node and all below it.
boolean	expand(VirtualCTreeNode node) Expands a node.
boolean	expandAll(VirtualCTreeNode node) Expands this node and all below it.
boolean	expandToLevel(int level) Expands the tree to a level.
boolean	expandToLevel(VirtualCTreeNode node, int level) Expands the node and its children up to a level.
void	fireCreate(Transaction trans) This method fires the creation data transaction to the client.
void	fireUpdate(Transaction trans) This method fires the update data transaction to the client.
String	getDefaultBranchImage() Gets the default image for branches.
String	getDefaultLeafImage() Gets the default image for leaves.
String	getDefaultRootImage() Gets the default image for the root.
VirtualCTreeNode	getFirstSelectedNode() Gets the first selected tree node.
int	getFlags() Gets the bit flags for the tree.
VirtualCTreeNode	getRoot() Gets the tree root node.
VirtualCTreeNode[]	getSelection() Gets the selection nodes.
void	issueAction(Transaction trans) This method is invoked by the server kernel when an event has occurred on the client side (such as a push button has been pressed).
boolean	setDefaultBranchImage(String image) Sets the default image for branches.
boolean	setDefaultLeafImage(String image) Sets the default image for leaves.
boolean	setDefaultRootImage(String image) Sets the default image for the root.
int	setFlags(int flags) Sets the flags.
boolean	setFocus() Sets the focus to this control.
boolean	setRoot(VirtualCTreeNode root) Assigns the root to the tree.
int	setSelection(VirtualCTreeNode... nodes) Sets a single or multiple node selection.

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

appendCreateTransaction, appendFieldCheckTransaction, appendFontTransaction, appendUpdateTransaction, areTextPromptsAlwaysRefreshed, callControl, callObject, callObject, deleteAll, deleteLine, dispose, getBackgroundColor, getBasicData, getCell, getClientSession, getColor, getComponentLockObject, getControlConnectedToHost, getControlID, getControlIDHostFieldID, getControlType, getCurrentHostSession, getExtraUpdateFlags, getFont, getForegroundColor, getHostField, getID, getIndex, getLength, getLine, getLineCount, getNextSelection, getObject, getPanel, getPreviousConnectedControl, getProperty, getSelectableControl, getText, getTextData, getTooltipText, getVirtualSessionManager, hasChanged, hostScreenChanged, insertLine, isChecked, isConnectToNextControlPropertySet, isDirectChecked, isEnabled, isNewGroup, issueControlAction, isTabSkipped, isVisible, parseRuntimeFont, refresh, refreshTextPrompts, 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

Field Detail

FLAG_SELECT_MASK

public static final int FLAG_SELECT_MASK

Tree flags, same as on server.

See Also:

Constant Field Values

FLAG_SELECT_SINGLE

public static final int FLAG_SELECT_SINGLE

See Also:

Constant Field Values

FLAG_SELECT_MULTI_CONT

public static final int FLAG_SELECT_MULTI_CONT

See Also:

Constant Field Values

FLAG_SELECT_MULTI_DISCONT

public static final int FLAG_SELECT_MULTI_DISCONT

See Also:

Constant Field Values

FLAG_BORDER

public static final int FLAG_BORDER

See Also:

Constant Field Values

FLAG_VERT

public static final int FLAG_VERT

See Also:

Constant Field Values

FLAG_HORZ

public static final int FLAG_HORZ

See Also:

Constant Field Values

FLAG_SHOW_ROOT

public static final int FLAG_SHOW_ROOT

See Also:

Constant Field Values

FLAG_SHOW_ROOT_HANDLES

public static final int FLAG_SHOW_ROOT_HANDLES

See Also:

Constant Field Values

FLAG_DBLCLK

public static final int FLAG_DBLCLK

See Also:

Constant Field Values

SELECTION_EVENT

public static final int SELECTION_EVENT

The selection event.

See Also:

Constant Field Values

DOUBLE_CLICK_EVENT

public static final int DOUBLE_CLICK_EVENT

The double-click event.

See Also:

Constant Field Values

Constructor Detail

VirtualCTree

public VirtualCTree(VirtualPanel panel,
                    PhantomCTree data)

The constructor of the control always calls the superclass.

Method Detail

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 fires the update data transaction to the client. If the base data or the text prompt has changed, appendUpdateTransaction will add everything required.

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. The entry field updates the text and also the host field if such a connection exists.

Specified by:

clientUpdated in class VirtualControl

Parameters:

trans - A transaction that is already being processed.

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.

issueAction

public void issueAction(Transaction trans)

This method is invoked by the server kernel when an event has occurred on the client side (such as a push button has been pressed). 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.

setDefaultRootImage

public boolean setDefaultRootImage(String image)

Sets the default image for the root.

Parameters:

image - The image or null to clear it.

Returns:

true for successful change, false for no changes done.

getDefaultRootImage

public String getDefaultRootImage()

Gets the default image for the root.

Returns:

The default image String or null for no default image.

setDefaultBranchImage

public boolean setDefaultBranchImage(String image)

Sets the default image for branches.

Parameters:

image - The image or null to clear it.

Returns:

true for successful change, false for no changes done.

getDefaultBranchImage

public String getDefaultBranchImage()

Gets the default image for branches.

Returns:

The default image String or null for no default image.

setDefaultLeafImage

public boolean setDefaultLeafImage(String image)

Sets the default image for leaves.

Parameters:

image - The image or null to clear it.

Returns:

true for successful change, false for no changes done.

getDefaultLeafImage

public String getDefaultLeafImage()

Gets the default image for leaves.

Returns:

The default image String or null for no default image.

setRoot

public boolean setRoot(VirtualCTreeNode root)

Assigns the root to the tree.

Parameters:

root - The root, or null to clear tree.

Returns:

true for changed, or false for no change.

Throws:

IllegalStateException - If the root is a root or has a parent.

getRoot

public VirtualCTreeNode getRoot()

Gets the tree root node.

Returns:

The tree root node or null if no root is present.

getFirstSelectedNode

public VirtualCTreeNode getFirstSelectedNode()

Gets the first selected tree node.

Returns:

The first selected tree node or null for none.

getSelection

public VirtualCTreeNode[] getSelection()

Gets the selection nodes.

Returns:

An array of the selected nodes, empty array for no selection.

setSelection

public int setSelection(VirtualCTreeNode... nodes)

Sets a single or multiple node selection.

Parameters:

nodes - The node(s) to select.

Returns:

1 for success, 0 for no change or -1 if a node is not in tree and selection has not been processed.

collapse

public boolean collapse(VirtualCTreeNode node)

Collapses a node.

Returns:

true for success, false if the node is not in the tree.

collapseAll

public boolean collapseAll(VirtualCTreeNode node)

Collapse this node and all below it.

Returns:

true for success, false if the node is not in the tree.

expand

public boolean expand(VirtualCTreeNode node)

Expands a node.

Returns:

true for success, false if the node is not in the tree.

expandAll

public boolean expandAll(VirtualCTreeNode node)

Expands this node and all below it.

Returns:

true for success, false if the node is not in the tree.

expandToLevel

public boolean expandToLevel(int level)

Expands the tree to a level.

Parameters:

level - Level 0 means that the root is expanded, and so on. Negative value does nothing.

Returns:

true for success, false for nothing done.

expandToLevel

public boolean expandToLevel(VirtualCTreeNode node,
                             int level)

Expands the node and its children up to a level.

Parameters:

level - Level 0 means that the root is expanded, and so on. Negative value does nothing.

Returns:

true for success, false for nothing done.

getFlags

public int getFlags()

Gets the bit flags for the tree. The flags are:

• FLAG_SELECT_SINGLE, Single selection.
• FLAG_SELECT_MULTI_CONT, multiple contiguous selection.
• FLAG_SELECT_MULTI_DISCONT, multiple discontiguous selection.
• FLAG_SHOW_ROOT, show the root node.
• FLAG_SHOW_ROOT_HANDLES, show root handles.
• FLAG_DBLCLK, double-click expands nodes.

The following flags can also be set:

• FLAG_BORDER, border around tree.
• FLAG_VERT, vertical scroll bar always visible.
• FLAG_HORZ, horizontal scroll bar always visible.

setFlags

public int setFlags(int flags)

Sets the flags.

• FLAG_SELECT_SINGLE, Single selection.
• FLAG_SELECT_MULTI_CONT, multiple contiguous selection.
• FLAG_SELECT_MULTI_DISCONT, multiple discontiguous selection.
• FLAG_SHOW_ROOT, show the root node.
• FLAG_SHOW_ROOT_HANDLES, show root handles.
• FLAG_DBLCLK, double-click expands nodes.

The following flags are removed from changes:

• FLAG_BORDER, border around tree.
• FLAG_VERT, vertical scroll bar always visible.
• FLAG_HORZ, horizontal scroll bar always visible.

Parameters:

flags - The flags as described above.

Returns:

1 for successful change, 0 for no change, -1 for error.