JavaComponentObject_Implements (NetPhantom® 8.0 Java API Specification)

java.lang.Object
- com.netphantom.template.JavaComponentObject_Implements

All Implemented Interfaces:
VirtualComponentListener, VirtualPanelListener
```
public class JavaComponentObject_Implements
extends Object
implements VirtualComponentListener
```
Java Component object listening to events for both the panel and the component(s). If the object is connected to a notebook panel, the event onPageActivated is also fired.

Field Summary
- Fields inherited from interface se.entra.phantom.server.VirtualPanelListener
  ICON_CRITICAL, ICON_INFORMATION, ICON_NOICON, ICON_QUERY, ICON_QUESTION, ICON_WARNING, 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

Constructor Summary
Constructors
Constructor and Description
JavaComponentObject_Implements()

Constructors
Constructor and Description
`JavaComponentObject_Implements()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`onAction(VirtualPanel panel, String controlID)` Push buttons and menu items (or pop-up menu items) generates this event when selected and the original `onAction` wasn't processed.
`void`	`onAction(VirtualPanel panel, VirtualControl control, String controlID)` Push buttons generates this event when selected.
`void`	`onAction(VirtualPanel panel, VirtualMenuItem menuItem, String controlID)` Menu items (or pop-up menu items) generates this event when selected.
`void`	`onCheckedChange(VirtualPanel panel, VirtualControl control, String controlID, int state)` Check boxes and radio buttons generates this event when state is changed on the client side.
`void`	`onContentChanged(VirtualPanel panel, VirtualControl control, String controlID, String text)` Entry fields and multiple line entry fields generates this message.
`void`	`onContentChanged(VirtualPanel panel, VirtualControl control, String controlID, String text, int line)` Combination boxes and spin buttons generates this message.
`void`	`onControlEvent(VirtualPanel panel, VirtualControl control, int event)` The general notification event for "normal" controls.
`void`	`onFocusGained(VirtualPanel panel, VirtualControl control, String controlID)` Controls that can receive input focus generates this event when they gain focus.
`void`	`onFocusLost(VirtualPanel panel, VirtualControl control, String controlID)` Controls that can receive input focus generates this event when they lose focus.
`void`	`onMenuAction(VirtualPanel panel, VirtualMenuItem menuItem)` Deprecated. Replaced with `onAction(VirtualPanel panel,VirtualMenuItem menuItem,String controlID)`.
`void`	`onPageActivated(VirtualPanel panel)` Called when a notebook page becomes active due to user interaction.
`boolean`	`onPanelClose(VirtualPanel panel)` Called when the close button of a panel is pressed.
`boolean`	`onPanelClosing(VirtualPanel panel)` Called when the close button of a panel is pressed, but before any other processing has been done.
`void`	`onPanelCreate(VirtualPanel panel)` Called to initialize the panel before it is displayed.
`void`	`onPanelDestroy(VirtualPanel panel)` Called to inform the listener that the panel is destroyed.
`void`	`onPropertyChange(VirtualPanel panel, VirtualControl control, String controlID, String propertyName, Object property)` A control notifies the listener using this event when custom properties needs to be handled.
`void`	`onSelectionChanged(VirtualPanel panel, VirtualCListBox list, String controlID, int line, int column)` List boxes generates this message.

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

- Constructor Detail
  - JavaComponentObject_Implements
```
public JavaComponentObject_Implements()
```
- Method Detail
  - onPanelCreate
```
public void onPanelCreate(VirtualPanel panel)
```
    Called to initialize the panel before it is displayed.
    This function doesn't perform anything.
    Specified by:
    onPanelCreate in interface VirtualPanelListener
    Parameters:
    panel - The panel issuing the event.
  - onPanelDestroy
```
public void onPanelDestroy(VirtualPanel panel)
```
    Called to inform the listener that the panel is destroyed. This method is guaranteed to be called, even if the client aborts due to e.g. an exception.
    Specified by:
    onPanelDestroy in interface VirtualPanelListener
    Parameters:
    panel - The panel issuing the event.
  - onPanelClosing
```
public boolean onPanelClosing(VirtualPanel panel)
```
    Called when the close button of a panel is pressed, but before any other processing has been done. If this function returns false, the application close object will be called (if defined), otherwise a faked key-press of the Escape key is performed. If these two actions failed (because there is no close object or no button or menu item is connected to the Escape key), then the function onPanelClose is called.
    Specified by:
    onPanelClosing in interface VirtualPanelListener
    Parameters:
    panel - The panel issuing the event.
    Returns:
    false to proceed with default processing, true to indicate alternate processing.
    See Also:
    VirtualPanelListener.onPanelClose(se.entra.phantom.server.VirtualPanel)
  - onPanelClose
```
public boolean onPanelClose(VirtualPanel panel)
```
    Called when the close button of a panel is pressed. When a panel has a listener attached to it, it will not perform default close operations. The listener should dismiss or destroy the panel unless canceling of the panel is not permitted.
    Specified by:
    onPanelClose in interface VirtualPanelListener
    Parameters:
    panel - The panel issuing the event.
    Returns:
    false to proceed with default processing, true to indicate alternate processing.
    See Also:
    VirtualPanelListener.onPanelClosing(se.entra.phantom.server.VirtualPanel)
  - onPageActivated
```
public void onPageActivated(VirtualPanel panel)
```
    Called when a notebook page becomes active due to user interaction. This call is directed to the notebook page listener.
    Specified by:
    onPageActivated in interface VirtualPanelListener
    Parameters:
    panel - The panel issuing the event.
  - onFocusGained
```
public void onFocusGained(VirtualPanel panel,
                          VirtualControl control,
                          String controlID)
```
    Controls that can receive input focus generates this event when they gain focus.
    Specified by:
    onFocusGained in interface VirtualComponentListener
    Parameters:
    panel - The panel issuing the event, parent of the control.
    control - The control issuing the event.
    controlID - The control ID issuing the event.
  - onFocusLost
```
public void onFocusLost(VirtualPanel panel,
                        VirtualControl control,
                        String controlID)
```
    Controls that can receive input focus generates this event when they lose focus.
    Specified by:
    onFocusLost in interface VirtualComponentListener
    Parameters:
    panel - The panel issuing the event, parent of the control.
    control - The control issuing the event.
    controlID - The control ID issuing the event.
  - onContentChanged
```
public void onContentChanged(VirtualPanel panel,
                             VirtualControl control,
                             String controlID,
                             String text)
```
    Entry fields and multiple line entry fields generates this message.
    Specified by:
    onContentChanged in interface VirtualComponentListener
    Parameters:
    panel - The panel issuing the event, parent of the control.
    control - The control issuing the event.
    controlID - The control ID issuing the event.
    text - The control text contents.
  - onContentChanged
```
public void onContentChanged(VirtualPanel panel,
                             VirtualControl control,
                             String controlID,
                             String text,
                             int line)
```
    Combination boxes and spin buttons generates this message. The line parameter is set to -1 if no line is selected.
    Specified by:
    onContentChanged in interface VirtualComponentListener
    Parameters:
    panel - The panel issuing the event, parent of the control.
    control - The control issuing the event.
    controlID - The control ID issuing the event.
    text - The control text contents.
    line - The selected line, or -1 for none.
  - onSelectionChanged
```
public void onSelectionChanged(VirtualPanel panel,
                               VirtualCListBox list,
                               String controlID,
                               int line,
                               int column)
```
    List boxes generates this message. The line and column parameter are individually set to -1 if no line or column is selected respectively.
    Specified by:
    onSelectionChanged in interface VirtualComponentListener
    Parameters:
    panel - The panel issuing the event, parent of the control.
    list - The list box control issuing the event.
    controlID - The control ID issuing the event.
    line - The selected line, or -1 for none.
    column - The selected column, or -1 for none.
  - onAction
```
public void onAction(VirtualPanel panel,
                     VirtualControl control,
                     String controlID)
```
    Push buttons generates this event when selected. If a class doesn't implement this method, the onAction(panel,controlID) method is called.
    Specified by:
    onAction in interface VirtualComponentListener
    Parameters:
    panel - The panel issuing the event, parent of the control.
    control - The control issuing the event.
    controlID - The control ID issuing the event.
  - onAction
```
public void onAction(VirtualPanel panel,
                     VirtualMenuItem menuItem,
                     String controlID)
```
    Menu items (or pop-up menu items) generates this event when selected. If a class doesn't implement this method, the onAction(panel,controlID) method is called.
    Specified by:
    onAction in interface VirtualComponentListener
    Parameters:
    panel - The panel issuing the event, parent of the control.
    menuItem - The menu item issuing the event.
    controlID - The control ID issuing the event.
  - onAction
```
public void onAction(VirtualPanel panel,
                     String controlID)
```
    Push buttons and menu items (or pop-up menu items) generates this event when selected and the original onAction wasn't processed.
    Parameters:
    panel - The panel issuing the event, parent of the control.
    controlID - The control ID issuing the event.
  - onControlEvent
```
public void onControlEvent(VirtualPanel panel,
                           VirtualControl control,
                           int event)
```
    The general notification event for "normal" controls.
    The event parameter is one of the events as defined with the CE_* variables.
    The event parameter can also be a user defined value that starts with CE_USER_DEFINED. In this case, the control parameter is a VirtualCUserWindow instance.
    This method is currently unused and reserved for future use.
    Specified by:
    onControlEvent in interface VirtualComponentListener
    Parameters:
    panel - The panel issuing the event, parent of the control.
    control - The control issuing the event.
    event - Event value.
  - onCheckedChange
```
public void onCheckedChange(VirtualPanel panel,
                            VirtualControl control,
                            String controlID,
                            int state)
```
    Check boxes and radio buttons generates this event when state is changed on the client side.
    The state is 0=unchecked, 1=checked and 2=third state (only for check boxes, or PhantomCCheckBox.STATE_UNDETERMINED).
    Specified by:
    onCheckedChange in interface VirtualComponentListener
    Parameters:
    panel - The panel issuing the event, parent of the control.
    control - The control issuing the event.
    controlID - The control ID issuing the event.
    state - State (0=unchecked, 1=checked and 2=third state [only for check boxes]).
  - onPropertyChange
```
public void onPropertyChange(VirtualPanel panel,
                             VirtualControl control,
                             String controlID,
                             String propertyName,
                             Object property)
```
    A control notifies the listener using this event when custom properties needs to be handled.
    The object is in general dependent of the property change event string.
    Specified by:
    onPropertyChange in interface VirtualComponentListener
    Parameters:
    panel - The panel issuing the event, parent of the control.
    control - The control issuing the event.
    controlID - The control ID issuing the event.
    propertyName - The property name.
    property - Property value depending on the property name.
  - onMenuAction
```
@Deprecated
public void onMenuAction(VirtualPanel panel,
                                      VirtualMenuItem menuItem)
```
    Deprecated. Replaced with onAction(VirtualPanel panel,VirtualMenuItem menuItem,String controlID).
    Menu items generates this event when selected.
    Specified by:
    onMenuAction in interface VirtualComponentListener

Class JavaComponentObject_Implements

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JavaComponentObject_Implements

Method Detail

onPanelCreate

onPanelDestroy

onPanelClosing

onPanelClose

onPageActivated

onFocusGained

onFocusLost

onContentChanged

onContentChanged

onSelectionChanged

onAction

onAction

onAction

onControlEvent

onCheckedChange

onPropertyChange

onMenuAction