com.filenet.wcm.apps.server.ui.select
Class ChoicePage

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

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

This class provide choice list for user to select. Choice list can display either horizontal or vertical. if your choice list display vertically please provide a colPadding value. This value use only in vertical type otherwise it is calculated by 100/total items.


Field Summary
static int ALIGN_HORIZONTAL
           
static int ALIGN_VERTICAL
           
static int TYPE_CHECKBOX
           
static int TYPE_RADIO
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
ChoicePage(java.lang.String formName, java.lang.String title, com.filenet.wcm.toolkit.util.WcmString[] items)
           
 
Method Summary
 com.filenet.wcm.toolkit.util.WcmString getSelectedItem()
          Return selected name
 void initialize()
          Initializes data
 void onSelectChoice(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Select event handler
 void render(java.io.Writer w)
          Renders the class data.
 void setAlign(int align)
           
 void setColPadding(int colPadding)
           
 void setDefault(com.filenet.wcm.toolkit.util.WcmString selectedItem)
           
 void setEnabled(boolean[] enabled)
          if this list is provided, it should has the same length as items.
 void setFormName(java.lang.String formName)
           
 void setParamName(java.lang.String paramName)
           
 void setType(int type)
           
 
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

ALIGN_VERTICAL

public static final int ALIGN_VERTICAL
See Also:
Constant Field Values

ALIGN_HORIZONTAL

public static final int ALIGN_HORIZONTAL
See Also:
Constant Field Values

TYPE_RADIO

public static final int TYPE_RADIO
See Also:
Constant Field Values

TYPE_CHECKBOX

public static final int TYPE_CHECKBOX
See Also:
Constant Field Values
Constructor Detail

ChoicePage

public ChoicePage(java.lang.String formName,
                  java.lang.String title,
                  com.filenet.wcm.toolkit.util.WcmString[] items)
           throws java.lang.Exception
Method Detail

setAlign

public void setAlign(int align)

setType

public void setType(int type)

setColPadding

public void setColPadding(int colPadding)

setParamName

public void setParamName(java.lang.String paramName)

setFormName

public void setFormName(java.lang.String formName)

setEnabled

public void setEnabled(boolean[] enabled)
if this list is provided, it should has the same length as items. And, this module will enable or disble item depends on its value at list. Default is enabled if value is missing.

Parameters:
enabled -

setDefault

public void setDefault(com.filenet.wcm.toolkit.util.WcmString selectedItem)
                throws java.lang.Exception
Throws:
java.lang.Exception

initialize

public void initialize()
                throws java.lang.Exception
Initializes data

Throws:
java.lang.Exception

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.

onSelectChoice

public void onSelectChoice(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)
                    throws java.lang.Exception
Select event handler

Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

getSelectedItem

public com.filenet.wcm.toolkit.util.WcmString getSelectedItem()
                                                       throws java.lang.Exception
Return selected name

Returns:
WcmString - Selected Item name
Throws:
java.lang.Exception


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