jACOB 2.7 API Documentation.

de.tif.jacob.screen.event
Class IListBoxEventHandler

java.lang.Object
  extended by EventHandler
      extended by de.tif.jacob.screen.event.GuiEventHandler
          extended by de.tif.jacob.screen.event.IGroupMemberEventHandler
              extended by de.tif.jacob.screen.event.IListBoxEventHandler
Direct Known Subclasses:
IMutableListBoxEventHandler

public abstract class IListBoxEventHandler
extends IGroupMemberEventHandler

Abstract event handler class for list boxes. Derived implementations of this event handler class have to be used to "hook" application-specific business logic to list boxes.


Field Summary
static java.lang.String RCS_ID
          The internal revision control system id.
static java.lang.String RCS_REV
          The internal revision control system id in short form.
 
Constructor Summary
IListBoxEventHandler()
           
 
Method Summary
 void onGroupStatusChanged(IClientContext context, IGuiElement.GroupState state, IGuiElement element)
          This event method will be called, if the status of the corresponding group has been changed.
abstract  void onGroupStatusChanged(IClientContext context, IGuiElement.GroupState state, IListBox listBox)
          This event method will be called, if the status of the corresponding group has been changed.
abstract  void onSelect(IClientContext context, IListBox listBox)
          This hook method will be called, if the user selects a new item in the list box.
 
Methods inherited from class de.tif.jacob.screen.event.IGroupMemberEventHandler
onHide, onShow
 
Methods inherited from class de.tif.jacob.screen.event.GuiEventHandler
alert, alert, alert
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RCS_ID

public static final transient java.lang.String RCS_ID
The internal revision control system id.

See Also:
Constant Field Values

RCS_REV

public static final transient java.lang.String RCS_REV
The internal revision control system id in short form.

See Also:
Constant Field Values
Constructor Detail

IListBoxEventHandler

public IListBoxEventHandler()
Method Detail

onGroupStatusChanged

public final void onGroupStatusChanged(IClientContext context,
                                       IGuiElement.GroupState state,
                                       IGuiElement element)
                                throws java.lang.Exception
Description copied from class: IGroupMemberEventHandler
This event method will be called, if the status of the corresponding group has been changed. Derived event handlers could overwrite this method, e.g. to enable/disable GUI elements in relation to the group state.
Possible group state values are defined in IGuiElement:

Overrides:
onGroupStatusChanged in class IGroupMemberEventHandler
Parameters:
context - The current client context
state - The new group state
element - The corresponding GUI element to this event handler
Throws:
java.lang.Exception

onGroupStatusChanged

public abstract void onGroupStatusChanged(IClientContext context,
                                          IGuiElement.GroupState state,
                                          IListBox listBox)
                                   throws java.lang.Exception
This event method will be called, if the status of the corresponding group has been changed. Derived event handlers could overwrite this method, e.g. to enable/disable GUI elements in relation to the group state.
Possible group state values are defined in IGuiElement:

Parameters:
context - The current client context
state - The new group state
listBox - The corresponding GUI element to this event handler
Throws:
java.lang.Exception

onSelect

public abstract void onSelect(IClientContext context,
                              IListBox listBox)
                       throws java.lang.Exception
This hook method will be called, if the user selects a new item in the list box.

Then overwriting this method, this is a good place for enable/disable other GUI elements.

Note: This method will only be invoked, if the corresponding group state is either IGuiElement.NEW or IGuiElement.UPDATE.

Parameters:
context - the current client context
listBox - the listbox itself
Throws:
java.lang.Exception

jACOB 2.7 API Documentation.