PControl (NetPhantom® 8.0 Java API Specification)

java.lang.Object
- se.entra.phantom.client.PControl

All Implemented Interfaces:
ContainerListener, MouseListener, MouseMotionListener, EventListener, DocumentListener, UserEventListener, NetPhantomConstants
Direct Known Subclasses:
CListBox, CMLE, CTree, CUserWindow
```
public class PControl
extends Object
implements MouseListener, MouseMotionListener, NetPhantomConstants, DocumentListener, UserEventListener, ContainerListener
```
This is the superclass for all controls in a panel. When created, the control must call the create method in order to read the basic control data from the create transaction.

Field Summary

Fields
Modifier and Type	Field and Description
`Bounds`	`bounds` Current bounds of the control.
`protected PPanel`	`panel` The control is inside this panel.
`static int`	`TYPE_BUTTON` Control type: push button.
`static int`	`TYPE_CHECK` Control type: check box.
`static int`	`TYPE_COMBO` Control type: combination box.
`static int`	`TYPE_FRAME` Control type: frame.
`static int`	`TYPE_GRAPH` Control type: business graphics.
`static int`	`TYPE_GROUP` Control type: group box.
`static int`	`TYPE_INOUT` Control type: entry field.
`static int`	`TYPE_LIST` Control type: list box.
`static int`	`TYPE_MLE` Control type: multiple-line entry field.
`static int`	`TYPE_NOTE` Control type: notebook.
`static int`	`TYPE_OUT` Control type: output text.
`static int`	`TYPE_RADIO` Control type: radio button.
`static int`	`TYPE_RECT` Control type: rectangle.
`static int`	`TYPE_SPIN` Control type: spin button.
`static int`	`TYPE_SUB` Control type: subwindow.
`static int`	`TYPE_TEXT` Control type: static text.
`static int`	`TYPE_TREE` Control type: tree.
`static int`	`TYPE_UNKNOWN` Control type: unknown.
`static int`	`TYPE_USER` Control type: user window.

Fields inherited from interface se.entra.phantom.common.NetPhantomConstants
ACTION_CLOSEWINDOW, ACTION_CONTROL, ACTION_HOSTKEY, ACTION_MENU, ACTION_NONE, ACTION_NOTEBOOKPAGE, ACTION_POPUPMENU, BUILD_NUMBER, BUILD_STRING, 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, TEST_BUILD, 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, VERSION_MAJOR, VERSION_MINOR, VERSION_NUMBER, VERSION_STRING, VSIGN_MINUS, VSIGN_NONE, VSIGN_PLUSMINUS, YEARF_6DIG, YEARF_8DIG, YEARF_EXP8

Constructor Summary
Constructors
Constructor and Description
PControl()

Constructors
Constructor and Description
`PControl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`changedUpdate(DocumentEvent e)` The entry field item has changed.
`void`	`componentAdded(ContainerEvent e)` Invoked when a component has been added to the container.
`void`	`componentRemoved(ContainerEvent e)` Invoked when a component has been removed from the container.
`int`	`getBackgroundIndex()` Gets the background color index of this control (zero is none).
`Component`	`getComponent()`
`Container`	`getContainer()`
`String`	`getControlID()` Gets the control ID.
`int`	`getFont()` Gets the font index of this control.
`int`	`getForegroundIndex()` Gets the foreground color index of this control (zero is none).
`int`	`getIndex()` Returns the index of the control in the panel.
`Phantom`	`getPhantomApplet()` Gets the reference to the Phantom instance (applet).
`se.entra.phantom.client.PCPopupMenu`	`getPopupMenu()` Gets the pop-up menu associated with this control (null for none).
`PPanel`	`getPPanel()`
`SessionManager`	`getSessionManager()` Gets the session manager.
`Color`	`getStandardBackground()` Get control standard background color.
`Color`	`getStandardForeground()` Get control standard foreground color.
`String`	`getText(Rectangle area)` Gets the text for the clipboard operation when performing a rectangle marking in the panel.
`String`	`getTooltipText()` Gets the tooltip text of this control, null for none.
`int`	`getType()` Gets the type of control (see values TYPE_*).
`void`	`insertUpdate(DocumentEvent e)` The entry field item is changed due to an insertion of text.
`boolean`	`isEnabled()` Checks if this control is enabled.
`boolean`	`isUserChanged()` Access method for the userChanged flag.
`void`	`mouseClicked(MouseEvent e)` Invoked when the mouse has been clicked on a component.
`void`	`mouseDragged(MouseEvent e)` Mouse dragged/moved.
`void`	`mouseEntered(MouseEvent e)` Invoked when the mouse enters a component (does nothing).
`void`	`mouseExited(MouseEvent e)` Invoked when the mouse exits a component (does nothing).
`void`	`mouseMoved(MouseEvent e)`
`void`	`mousePressed(MouseEvent e)` Invoked when a mouse button has been pressed on a component.
`void`	`mouseReleased(MouseEvent e)`
`void`	`notifyUserEvent(int event)` Notification of a user event.
`void`	`removeUpdate(DocumentEvent e)` The entry field item is changed due to text removal.
`void`	`setEnabled(boolean s)` Sets the enabled state of this control.
`void`	`setMarkingAllowed(boolean on)` Sets if marking is allowed in the panel.
`void`	`setTabHandled()` Check if this control skips the tab stop or not.
`void`	`setUserChanged(boolean isUserChanged)` Access method to set the userChanged flag from the actual control.
`void`	`setUserChangeLightEvent(boolean userChangeLightEvent)` Set User change light-event on every document change.
`protected void`	`showPopupMenu(se.entra.phantom.client.PCPopupMenu popupMenu, Component component, int x, int y, int index, int column)` Shows the pop-up menu.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TYPE_UNKNOWN
```
public static final int TYPE_UNKNOWN
```
    Control type: unknown.
    See Also:
    Constant Field Values
  - TYPE_TEXT
```
public static final int TYPE_TEXT
```
    Control type: static text.
    See Also:
    Constant Field Values
  - TYPE_INOUT
```
public static final int TYPE_INOUT
```
    Control type: entry field.
    See Also:
    Constant Field Values
  - TYPE_LIST
```
public static final int TYPE_LIST
```
    Control type: list box.
    See Also:
    Constant Field Values
  - TYPE_BUTTON
```
public static final int TYPE_BUTTON
```
    Control type: push button.
    See Also:
    Constant Field Values
  - TYPE_CHECK
```
public static final int TYPE_CHECK
```
    Control type: check box.
    See Also:
    Constant Field Values
  - TYPE_RADIO
```
public static final int TYPE_RADIO
```
    Control type: radio button.
    See Also:
    Constant Field Values
  - TYPE_OUT
```
public static final int TYPE_OUT
```
    Control type: output text.
    See Also:
    Constant Field Values
  - TYPE_GROUP
```
public static final int TYPE_GROUP
```
    Control type: group box.
    See Also:
    Constant Field Values
  - TYPE_RECT
```
public static final int TYPE_RECT
```
    Control type: rectangle.
    See Also:
    Constant Field Values
  - TYPE_FRAME
```
public static final int TYPE_FRAME
```
    Control type: frame.
    See Also:
    Constant Field Values
  - TYPE_GRAPH
```
public static final int TYPE_GRAPH
```
    Control type: business graphics.
    See Also:
    Constant Field Values
  - TYPE_USER
```
public static final int TYPE_USER
```
    Control type: user window. The bar control and the external image is also a user window.
    See Also:
    Constant Field Values
  - TYPE_MLE
```
public static final int TYPE_MLE
```
    Control type: multiple-line entry field.
    See Also:
    Constant Field Values
  - TYPE_COMBO
```
public static final int TYPE_COMBO
```
    Control type: combination box.
    See Also:
    Constant Field Values
  - TYPE_SPIN
```
public static final int TYPE_SPIN
```
    Control type: spin button.
    See Also:
    Constant Field Values
  - TYPE_SUB
```
public static final int TYPE_SUB
```
    Control type: subwindow.
    See Also:
    Constant Field Values
  - TYPE_NOTE
```
public static final int TYPE_NOTE
```
    Control type: notebook.
    See Also:
    Constant Field Values
  - TYPE_TREE
```
public static final int TYPE_TREE
```
    Control type: tree.
    See Also:
    Constant Field Values
  - bounds
```
public Bounds bounds
```
    Current bounds of the control.
  - panel
```
protected PPanel panel
```
    The control is inside this panel.
- Constructor Detail
  - PControl
```
public PControl()
```
- Method Detail
  - getControlID
```
public String getControlID()
```
    Gets the control ID. This is "null" if the panel does not have extended create information flags set, or also if the control ID has not yet been read from the Create transaction. The control ID could be an empty string if no ID is assigned to the control.
  - componentAdded
```
public void componentAdded(ContainerEvent e)
```
    Invoked when a component has been added to the container.
    Specified by:
    componentAdded in interface ContainerListener
  - componentRemoved
```
public void componentRemoved(ContainerEvent e)
```
    Invoked when a component has been removed from the container.
    Specified by:
    componentRemoved in interface ContainerListener
  - getPhantomApplet
```
public Phantom getPhantomApplet()
```
    Gets the reference to the Phantom instance (applet).
  - getSessionManager
```
public SessionManager getSessionManager()
```
    Gets the session manager.
  - getPPanel
```
public PPanel getPPanel()
```
  - getComponent
```
public Component getComponent()
```
  - getContainer
```
public Container getContainer()
```
  - getFont
```
public int getFont()
```
    Gets the font index of this control.
  - getForegroundIndex
```
public int getForegroundIndex()
```
    Gets the foreground color index of this control (zero is none).
  - getBackgroundIndex
```
public int getBackgroundIndex()
```
    Gets the background color index of this control (zero is none).
  - getType
```
public int getType()
```
    Gets the type of control (see values TYPE_*).
  - isEnabled
```
public boolean isEnabled()
```
    Checks if this control is enabled.
  - setEnabled
```
public void setEnabled(boolean s)
```
    Sets the enabled state of this control.
  - getIndex
```
public int getIndex()
```
    Returns the index of the control in the panel. The index does not restart at zero for subwindows.
  - setTabHandled
```
public void setTabHandled()
```
    Check if this control skips the tab stop or not.
  - getPopupMenu
```
public se.entra.phantom.client.PCPopupMenu getPopupMenu()
```
    Gets the pop-up menu associated with this control (null for none).
  - mouseClicked
```
public void mouseClicked(MouseEvent e)
```
    Invoked when the mouse has been clicked on a component.
    This will display a pop-up menu if mouse button 2 (the right one) is pressed inside the control. Actually, it's not only the button 2 or the right one, rather the AWT implementation (see MouseEvent.isPopupTrigger()).
    Specified by:
    mouseClicked in interface MouseListener
  - mousePressed
```
public void mousePressed(MouseEvent e)
```
    Invoked when a mouse button has been pressed on a component. The pop-up menu (if any) is displayed as required. Rectangle marking in the panel is also initiated here.
    Specified by:
    mousePressed in interface MouseListener
  - mouseDragged
```
public void mouseDragged(MouseEvent e)
```
    Mouse dragged/moved.
    Specified by:
    mouseDragged in interface MouseMotionListener
  - mouseMoved
```
public void mouseMoved(MouseEvent e)
```
    Specified by:
    mouseMoved in interface MouseMotionListener
  - mouseReleased
```
public void mouseReleased(MouseEvent e)
```
    Specified by:
    mouseReleased in interface MouseListener
  - showPopupMenu
```
protected void showPopupMenu(se.entra.phantom.client.PCPopupMenu popupMenu,
                             Component component,
                             int x,
                             int y,
                             int index,
                             int column)
```
    Shows the pop-up menu.
  - mouseEntered
```
public void mouseEntered(MouseEvent e)
```
    Invoked when the mouse enters a component (does nothing).
    Specified by:
    mouseEntered in interface MouseListener
  - mouseExited
```
public void mouseExited(MouseEvent e)
```
    Invoked when the mouse exits a component (does nothing).
    Specified by:
    mouseExited in interface MouseListener
  - getStandardForeground
```
public Color getStandardForeground()
```
    Get control standard foreground color.
  - getStandardBackground
```
public Color getStandardBackground()
```
    Get control standard background color.
  - isUserChanged
```
public boolean isUserChanged()
```
    Access method for the userChanged flag.
  - setUserChanged
```
public void setUserChanged(boolean isUserChanged)
```
    Access method to set the userChanged flag from the actual control.
  - setUserChangeLightEvent
```
public void setUserChangeLightEvent(boolean userChangeLightEvent)
```
    Set User change light-event on every document change.
  - changedUpdate
```
public void changedUpdate(DocumentEvent e)
```
    The entry field item has changed.
    Specified by:
    changedUpdate in interface DocumentListener
  - insertUpdate
```
public void insertUpdate(DocumentEvent e)
```
    The entry field item is changed due to an insertion of text.
    Specified by:
    insertUpdate in interface DocumentListener
  - removeUpdate
```
public void removeUpdate(DocumentEvent e)
```
    The entry field item is changed due to text removal.
    Specified by:
    removeUpdate in interface DocumentListener
  - notifyUserEvent
```
public void notifyUserEvent(int event)
```
    Notification of a user event.
    Specified by:
    notifyUserEvent in interface UserEventListener
  - setMarkingAllowed
```
public void setMarkingAllowed(boolean on)
```
    Sets if marking is allowed in the panel. For text fields and list boxes, it is not allowed.
  - getText
```
public String getText(Rectangle area)
```
    Gets the text for the clipboard operation when performing a rectangle marking in the panel. Tab and CR/LF are allowed, e.g. for a listbox.
    Returns:
    null if not available.
  - getTooltipText
```
public String getTooltipText()
```
    Gets the tooltip text of this control, null for none.

Class PControl

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE_UNKNOWN

TYPE_TEXT

TYPE_INOUT

TYPE_LIST

TYPE_BUTTON

TYPE_CHECK

TYPE_RADIO

TYPE_OUT

TYPE_GROUP

TYPE_RECT

TYPE_FRAME

TYPE_GRAPH

TYPE_USER

TYPE_MLE

TYPE_COMBO

TYPE_SPIN

TYPE_SUB

TYPE_NOTE

TYPE_TREE

bounds

panel

Constructor Detail

PControl

Method Detail

getControlID

componentAdded

componentRemoved

getPhantomApplet

getSessionManager

getPPanel

getComponent

getContainer

getFont

getForegroundIndex

getBackgroundIndex

getType

isEnabled

setEnabled

getIndex

setTabHandled

getPopupMenu

mouseClicked

mousePressed

mouseDragged

mouseMoved

mouseReleased

showPopupMenu

mouseEntered

mouseExited

getStandardForeground

getStandardBackground

isUserChanged

setUserChanged

setUserChangeLightEvent

changedUpdate

insertUpdate

removeUpdate

notifyUserEvent

setMarkingAllowed

getText

getTooltipText