|
||||||||||
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.apps.server.ui.WcmInstruction
Display instructions in a text area with options to hide or to display.
Field Summary | |
protected java.util.Locale |
locale
|
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule |
NAME_DELIMITER |
Constructor Summary | |
WcmInstruction()
|
Method Summary | |
java.lang.String |
getInstructionsText()
Returns the instruction text (as String) |
void |
initialize()
|
void |
onCollapse(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Event that occurs when user collapses the instruction module. |
void |
onExpand(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Event that occurs when user expands the instruction module. |
void |
render(java.io.Writer w)
Renders the class data. |
protected void |
renderWithInstructions(java.io.Writer w)
Render the expanded view. |
protected void |
renderWithoutInstructions(java.io.Writer w,
boolean expand)
Render without the collapsed view. |
void |
setDefaultInstructionsMode(boolean isCollapsed)
Set the default instruction view mode. |
void |
setEventTargetName(java.lang.String value)
Set event target name. |
void |
setFormSubmitName(java.lang.String value)
Set form submit name. |
void |
setInstructionsText(java.lang.String instructions)
Set the instruction text (as String) |
void |
setInstructionsText(com.filenet.wcm.toolkit.util.WcmString instructions)
Set the instruction text. |
void |
setRows(int rows)
Set the number of visible instruction text lines. |
void |
setWidthPercentage(int value)
Set the width parameter for the instruction box. |
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.Locale locale
Constructor Detail |
public WcmInstruction()
Method Detail |
public void setWidthPercentage(int value)
value
- - an int value between 1 and 100 representing 1% to 100% width.public void initialize() throws java.lang.Exception
java.lang.Exception
public void setFormSubmitName(java.lang.String value)
value
- Form submit namepublic void setEventTargetName(java.lang.String value)
value
- Event target namepublic void setDefaultInstructionsMode(boolean isCollapsed)
isCollapsed
- True to collapse the instruction text; False to show instruction.public void setInstructionsText(com.filenet.wcm.toolkit.util.WcmString instructions)
instructions
- Instruction text (as WcmString)public void setInstructionsText(java.lang.String instructions)
instructions
- Instruction textpublic java.lang.String getInstructionsText()
public void setRows(int rows)
rows
- Number of visible linespublic void render(java.io.Writer w) throws java.lang.Exception
w
- Writer for writing to the response object.
java.lang.Exception
- If there are problems.public void onCollapse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest is the jsp request object.response
- HttpServletResponse is the jsp response object.
java.lang.Exception
- If there are problems.public void onExpand(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest is the jsp request object.response
- HttpServletResponse is the jsp response object.
java.lang.Exception
- If there are problems.protected void renderWithoutInstructions(java.io.Writer w, boolean expand) throws java.lang.Exception
w
- Writer
java.lang.Exception
protected void renderWithInstructions(java.io.Writer w) throws java.lang.Exception
w
- - Writer
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |