|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.wcm.toolkit.server.base.WcmDpContainer
com.filenet.wcm.toolkit.server.base.WcmModule
com.filenet.wcm.toolkit.server.base.GlobalEventModule
com.filenet.wcm.toolkit.server.base.WcmUiModule
com.filenet.wcm.toolkit.server.ui.WcmAnchorList
Primitive UI module that represents a list of WcmAnchor objects.
Field Summary | |
protected java.util.List |
anchorList
|
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule |
locale, NAME_DELIMITER |
Constructor Summary | |
WcmAnchorList()
|
Method Summary | |
int |
addAnchor(java.lang.String url,
java.lang.String label)
Adds new WcmAnchor to the list by creating a new WcmAnchor from parameters. |
int |
addAnchor(java.lang.String url,
java.lang.String label,
java.lang.String iconUrl)
Adds new WcmAnchor to the list by creating a new WcmAnchor from parameters. |
int |
addAnchor(java.lang.String url,
WcmString label)
Adds new WcmAnchor to the list by creating a new WcmAnchor from parameters. |
int |
addAnchor(java.lang.String url,
WcmString label,
java.lang.String iconUrl)
Adds new WcmAnchor to the list by creating a new WcmAnchor from parameters. |
int |
addAnchor(java.lang.String url,
WcmString label,
java.lang.String iconUrl,
WcmString toolTip)
Adds new WcmAnchor to the list by creating a new WcmAnchor from parameters. |
int |
addAnchor(WcmAnchor a)
Adds new WcmAnchor to the list |
void |
clear()
Clears the Anchor List |
WcmAnchor |
getAnchor(int idx)
Returns the anchor by it's index. |
int |
getLength()
Returns the length of the anchor contained in anchor.size. |
void |
initialize()
Called by WcmController when the module is registered, and has access to the data store. |
int |
insertAnchor(int idx,
WcmAnchor a,
boolean after)
Insert a new WcmAnchor to the list at the specified index |
WcmAnchor |
removeAnchor(int idx)
Removes a WcmAnchor from the list |
void |
render(java.io.Writer w)
Renders the anchor list html. |
protected abstract void |
renderAnchor(java.io.Writer w,
int idx,
int max,
WcmAnchor a)
This method needs to be defined in an implementation of WcmAnchorList. |
protected void |
renderClosingHTML(java.io.Writer w)
This method may be defined in an implementation of WcmAnchorList. |
protected void |
renderOpeningHTML(java.io.Writer w)
This method may be defined in an implementation of WcmAnchorList. |
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 |
protected java.util.List anchorList
Constructor Detail |
public WcmAnchorList()
Method Detail |
public void initialize() throws java.lang.Exception
WcmModuleInterface
initialize
in interface WcmModuleInterface
initialize
in class WcmModule
java.lang.Exception
public int getLength()
public int addAnchor(java.lang.String url, WcmString label)
url
- URL value of WcmAnchor to create and add to list.label
- Label of WcmAnchor to create and add to list.
public int addAnchor(java.lang.String url, java.lang.String label)
url
- URL value of WcmAnchor to create and add to list.label
- Label of WcmAnchor to create and add to list.
public int addAnchor(java.lang.String url, WcmString label, java.lang.String iconUrl)
url
- URL value of WcmAnchor to create and add to list.label
- Label of WcmAnchor to create and add to list.iconUrl
- Url of icon of WcmAnchor to create and add to list.public int addAnchor(java.lang.String url, java.lang.String label, java.lang.String iconUrl)
url
- URL value of WcmAnchor to create and add to list.label
- Label of WcmAnchor to create and add to list.iconUrl
- Url of icon of WcmAnchor to create and add to list.public int addAnchor(java.lang.String url, WcmString label, java.lang.String iconUrl, WcmString toolTip)
url
- URL value of WcmAnchor to create and add to list.label
- Label of WcmAnchor to create and add to list.iconUrl
- Url of icon of WcmAnchor to create and add to list.toolTip
- Tooltip of WcmAnchor to create and add to list.public int addAnchor(WcmAnchor a)
a
- new WcmAnchor to add to the listpublic int insertAnchor(int idx, WcmAnchor a, boolean after)
idx
- The index to insert this anchor at.a
- A new WcmAnchor to add to the list
public WcmAnchor removeAnchor(int idx) throws java.lang.Exception
idx
- The index to remove.
java.lang.Exception
public WcmAnchor getAnchor(int idx)
idx
- anchor index
java.lang.IndexOutOfBoundsException
- when the index is out of boundsprotected abstract void renderAnchor(java.io.Writer w, int idx, int max, WcmAnchor a) throws java.lang.Exception
w
- Writer objectidx
- index of the current anchormax
- index of the last anchora
- WcmAnchor object
java.lang.Exception
- All Exceptionsprotected void renderOpeningHTML(java.io.Writer w) throws java.lang.Exception
w
- Writer object
java.lang.Exception
protected void renderClosingHTML(java.io.Writer w) throws java.lang.Exception
w
- Writer object
java.lang.Exception
- All Exceptionspublic void render(java.io.Writer w) throws java.lang.Exception
render
in interface WcmUiModuleInterface
render
in class WcmUiModule
w
- Writer object
java.lang.Exception
- All Exceptionspublic void clear()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |