IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.rcp.xui.action
Class HelpButtonAction

java.lang.Object
  extended by com.ibm.btt.rcp.xui.action.Action
      extended by com.ibm.btt.rcp.xui.action.HelpButtonAction
All Implemented Interfaces:
IAction

public class HelpButtonAction
extends Action

This HelpButtonAction may be assigned to a button inside a composite/a group. The action may be only called from a UI thread.


Constructor Summary
HelpButtonAction()
           
 
Method Summary
 java.lang.String getHelpId()
          Get Help ID for looking up the help contents.
 void setHelpId(java.lang.String helpId)
          Set Help ID for looking up the help contents.
 boolean widgetSelected(IXUIWidget source)
          Invoke when selection occurs in the control.
 
Methods inherited from class com.ibm.btt.rcp.xui.action.Action
focusGained, focusLost, keyPressed, keyReleased, modifyText, mouseDoubleClick, mouseDown, mouseUp, verifyText, widgetDisposed
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HelpButtonAction

public HelpButtonAction()
Method Detail

widgetSelected

public boolean widgetSelected(IXUIWidget source)
Description copied from interface: IAction
Invoke when selection occurs in the control.

For example, selection occurs in a List when the user selects an item or items with the keyboard or mouse. On some platforms, the event occurs when a mouse button or key is pressed. On others, it happens when the mouse or key is released. The exact key or mouse gesture that causes this event is platform specific.

Current support widgets: Button, Table, ComboBox, RadioButton, CheckBox, List

Specified by:
widgetSelected in interface IAction
Overrides:
widgetSelected in class Action
Parameters:
source - source widget which invoke this action
Returns:
boolean value which depending on the event, a flag indicating whether the operation should be allowed. Setting this field to false will cancel the operation.

getHelpId

public java.lang.String getHelpId()
Get Help ID for looking up the help contents.

Returns:

setHelpId

public void setHelpId(java.lang.String helpId)
Set Help ID for looking up the help contents.

Parameters:
helpId -

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2011