IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.rcp.xui.widgets
Class XUIWidget

java.lang.Object
  extended by com.ibm.btt.rcp.xui.widgets.XUIWidget
All Implemented Interfaces:
IKeyHolder, IXUIEventListener, IXUIWidget
Direct Known Subclasses:
XUISWTWidget

public abstract class XUIWidget
extends java.lang.Object
implements IXUIWidget

Abstract XUI Widget class, all XUI widgets need to extends from this class.


Constructor Summary
XUIWidget()
           
 
Method Summary
 void dispose()
          Dispose this widget, release resources.
 void fireXUIEvent(IXUIEventObject object)
          Fire XUI Event out
 java.util.List<IAction> getActions()
          Get actions of this widget
 java.lang.String getHelpId()
          Get Help ID for looking up the help contents.
 java.lang.String getId()
          Get id property for this holder
 java.util.List<IInitializer> getInitializers()
          Get initializers of this widget.
 IXUIComposite getParent()
          Get parent XUI composite
 int getTabIndex()
          Get tab focus sequence.
 IXUIView getXUIView()
          Get XUI View of this widget
protected  void handleRequired()
          Logic execute when widget is required
 void handleXUIEvent(IXUIEventObject object)
          Logics when receive XUI events
 void setActions(java.util.List<IAction> actions)
          Set actions of this widget
 void setHelpId(java.lang.String helpId)
          Set Help ID for looking up the help contents.
 void setId(java.lang.String id)
          Set id property for this holder
 void setInitializers(java.util.List<IInitializer> initializers)
          Set initializers of this widget.
 void setParent(IXUIComposite parent)
          Set parent XUI composite
 void setTabIndex(int tabIndex)
          Define tab focus sequence.
 void setXUIView(IXUIView view)
          Set XUI View of this widget
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.btt.rcp.xui.widgets.IXUIWidget
getWidget, getWidgetType
 

Constructor Detail

XUIWidget

public XUIWidget()
Method Detail

getParent

public IXUIComposite getParent()
Description copied from interface: IXUIWidget
Get parent XUI composite

Specified by:
getParent in interface IXUIWidget
Returns:

setParent

public void setParent(IXUIComposite parent)
Description copied from interface: IXUIWidget
Set parent XUI composite

Specified by:
setParent in interface IXUIWidget

setInitializers

public void setInitializers(java.util.List<IInitializer> initializers)
Set initializers of this widget.

Parameters:
initializers -

getInitializers

public java.util.List<IInitializer> getInitializers()
Get initializers of this widget.

Returns:

getActions

public java.util.List<IAction> getActions()
Get actions of this widget

Returns:

setActions

public void setActions(java.util.List<IAction> actions)
Set actions of this widget

Parameters:
actions -

getId

public java.lang.String getId()
Description copied from interface: IKeyHolder
Get id property for this holder

Specified by:
getId in interface IKeyHolder
Returns:

setId

public void setId(java.lang.String id)
Description copied from interface: IKeyHolder
Set id property for this holder

Specified by:
setId in interface IKeyHolder

getXUIView

public IXUIView getXUIView()
Description copied from interface: IXUIWidget
Get XUI View of this widget

Specified by:
getXUIView in interface IXUIWidget
Returns:

setXUIView

public void setXUIView(IXUIView view)
Description copied from interface: IXUIWidget
Set XUI View of this widget

Specified by:
setXUIView in interface IXUIWidget

handleRequired

protected void handleRequired()
Logic execute when widget is required


handleXUIEvent

public void handleXUIEvent(IXUIEventObject object)
Description copied from interface: IXUIEventListener
Logics when receive XUI events

Specified by:
handleXUIEvent in interface IXUIEventListener
Parameters:
object - XUI event object

fireXUIEvent

public void fireXUIEvent(IXUIEventObject object)
Fire XUI Event out

Parameters:
object -

dispose

public void dispose()
Dispose this widget, release resources.

Specified by:
dispose in interface IXUIWidget

getTabIndex

public int getTabIndex()
Get tab focus sequence.

Returns:

setTabIndex

public void setTabIndex(int tabIndex)
Define tab focus sequence.

Parameters:
tabIndex -

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, 2009