com.filenet.wcm.toolkit.server.ui
Class WcmSelectableAnchorList

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.base.WcmDpContainer
      extended bycom.filenet.wcm.toolkit.server.base.WcmModule
          extended bycom.filenet.wcm.toolkit.server.base.GlobalEventModule
              extended bycom.filenet.wcm.toolkit.server.base.WcmUiModule
                  extended bycom.filenet.wcm.toolkit.server.ui.WcmAnchorList
                      extended bycom.filenet.wcm.toolkit.server.ui.WcmSelectableAnchorList
All Implemented Interfaces:
WcmModuleInterface, WcmUiModuleInterface

public abstract class WcmSelectableAnchorList
extends WcmAnchorList

This class implements an selectable anchor list. It extends from the base WcmAnchorList module and implements its selection mechanism.


Field Summary
protected  int selection
          The index of the selected anchor in the anchor list.
 
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmAnchorList
anchorList
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WcmSelectableAnchorList()
           
 
Method Summary
 int clearSelection()
          Clears the anchor list selection.
 int getSelection()
          Gets the current anchor list selection index.
 void initialize()
          Initializes the WcmSelectableAnchorList module by setting the current anchor selection.
 int setSelection(int newSelection)
          Selects the anchor by the anchor index.
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmAnchorList
addAnchor, addAnchor, addAnchor, addAnchor, addAnchor, addAnchor, clear, getAnchor, getLength, insertAnchor, removeAnchor, render, renderAnchor, renderClosingHTML, renderOpeningHTML
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmUiModule
getActive, getBasePath, getBaseUrl, getBaseURLBuilder, getControllerEventUrl, getControllerEventUrl, getEventFormFields, getEventFormFields, getEventFormTag, getEventFormTag, getEventUrl, getEventUrl, getEventUrl, getEventUrl, getFormName, getFormSubmitUrl, getFormSubmitUrl, getGlobalEventUrl, getGlobalEventUrl, getPageUrl, getPageUrl, getPageUrl, getPageUrl, getUiParent, peekEvent, renderJSP, routeEvent, routeEvent, serverSideInclude, serverSideInclude, setActive, setJSP
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.GlobalEventModule
onStartPage, subscribeGlobalEvent
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
addChild, addChild, addChild, cleanup, debugTrace, getClassProperty, getClassProperty, getClassPropertyKeys, getConfiguration, getController, getDataStore, getModuleProperty, getModuleProperty, getModuleProperty, getModuleProperty, getModulePropertyKeys, getName, getParent, getWindowProperty, getWindowProperty, persist, queryDataProvider, setClassProperty, setClassProperty, setController, setModuleProperty, setModuleProperty, setName, setParent, setPortletParent, setWindowProperty
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmDpContainer
addDataProvider, addDataProvider
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
onStartPage
 
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
addDataProvider, cleanup, getDataStore, getModuleProperty, getName, getParent, persist, queryDataProvider, setController, setModuleProperty, setName, setParent
 

Field Detail

selection

protected int selection
The index of the selected anchor in the anchor list.

Constructor Detail

WcmSelectableAnchorList

public WcmSelectableAnchorList()
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes the WcmSelectableAnchorList module by setting the current anchor selection. If there wasn't any set by the user, then the default selection will be used.

Specified by:
initialize in interface WcmModuleInterface
Overrides:
initialize in class WcmAnchorList
Throws:
java.lang.Exception - All Exceptions

setSelection

public int setSelection(int newSelection)
                 throws java.lang.Exception
Selects the anchor by the anchor index.

Parameters:
newSelection - The index of the anchor to be selected.
Returns:
The previously selected anchor index.
Throws:
java.lang.Exception - All Exceptions.

getSelection

public int getSelection()
Gets the current anchor list selection index.

Returns:
The index of the current selected anchor.
Throws:
java.lang.Exception - All Exceptions.

clearSelection

public int clearSelection()
                   throws java.lang.Exception
Clears the anchor list selection.

Returns:
The previously selected anchor index.
Throws:
java.lang.Exception - All Exceptions.


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.