com.filenet.wcm.apps.server.ui
Class WcmInstruction

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.apps.server.ui.WcmInstruction
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

public class WcmInstruction
extends com.filenet.wcm.toolkit.server.base.WcmUiModule

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

locale

protected java.util.Locale locale
Constructor Detail

WcmInstruction

public WcmInstruction()
Method Detail

setWidthPercentage

public void setWidthPercentage(int value)
Set the width parameter for the instruction box. Default is 100%.

Parameters:
value - - an int value between 1 and 100 representing 1% to 100% width.

initialize

public void initialize()
                throws java.lang.Exception
Throws:
java.lang.Exception

setFormSubmitName

public void setFormSubmitName(java.lang.String value)
Set form submit name.

Parameters:
value - Form submit name

setEventTargetName

public void setEventTargetName(java.lang.String value)
Set event target name.

Parameters:
value - Event target name

setDefaultInstructionsMode

public void setDefaultInstructionsMode(boolean isCollapsed)
Set the default instruction view mode.

Parameters:
isCollapsed - True to collapse the instruction text; False to show instruction.

setInstructionsText

public void setInstructionsText(com.filenet.wcm.toolkit.util.WcmString instructions)
Set the instruction text.

Parameters:
instructions - Instruction text (as WcmString)

setInstructionsText

public void setInstructionsText(java.lang.String instructions)
Set the instruction text (as String)

Parameters:
instructions - Instruction text

getInstructionsText

public java.lang.String getInstructionsText()
Returns the instruction text (as String)

Returns:
String with the instructions text

setRows

public void setRows(int rows)
Set the number of visible instruction text lines.

Parameters:
rows - Number of visible lines

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders the class data.

Parameters:
w - Writer for writing to the response object.
Throws:
java.lang.Exception - If there are problems.

onCollapse

public void onCollapse(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws java.lang.Exception
Event that occurs when user collapses the instruction module.

Parameters:
request - HttpServletRequest is the jsp request object.
response - HttpServletResponse is the jsp response object.
Throws:
java.lang.Exception - If there are problems.

onExpand

public void onExpand(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Event that occurs when user expands the instruction module.

Parameters:
request - HttpServletRequest is the jsp request object.
response - HttpServletResponse is the jsp response object.
Throws:
java.lang.Exception - If there are problems.

renderWithoutInstructions

protected void renderWithoutInstructions(java.io.Writer w,
                                         boolean expand)
                                  throws java.lang.Exception
Render without the collapsed view.

Parameters:
w - Writer
Throws:
java.lang.Exception

renderWithInstructions

protected void renderWithInstructions(java.io.Writer w)
                               throws java.lang.Exception
Render the expanded view.

Parameters:
w - - Writer
Throws:
java.lang.Exception


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