com.filenet.wcm.apps.server.ui.prefs
Class WcmPreferenceSetting

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

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


Nested Class Summary
protected static class WcmPreferenceSetting.ListBoxItem
           
 
Field Summary
protected  boolean bRenderDefaultsColumn
           
protected  boolean bRenderPasswordField
           
protected  boolean bRenderTextArea
           
protected  java.lang.String descriptionColumnVAlign
           
protected  java.util.List listBoxItems
           
protected  java.util.Locale locale
           
protected  boolean requiredField
           
protected  boolean requiredFieldColumn
           
protected  java.lang.String sAdditionalHtml
           
protected  java.lang.String sAdditionalText
           
protected  java.lang.String sDefaultColumn
           
protected  java.lang.String sDescriptionColumn
           
protected  java.lang.String sInputFieldName
           
protected  java.lang.String sPasswordBoxValue
           
protected  java.lang.String sSelectedListBoxItem
           
protected  java.lang.String sTextBoxValue
           
protected  boolean translateColumnText
           
static com.filenet.wcm.toolkit.util.WcmString wsNo
           
static com.filenet.wcm.toolkit.util.WcmString wsYes
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
NAME_DELIMITER
 
Constructor Summary
WcmPreferenceSetting()
           
WcmPreferenceSetting(java.util.Locale locale)
          Use this constructor and you don't have to register this module
 
Method Summary
 void addListBoxItem(java.lang.String sDisplayText, java.lang.String sValue)
           
 void addListBoxItem(com.filenet.wcm.toolkit.util.WcmString wsDisplayText, boolean value)
           
 void addListBoxItem(com.filenet.wcm.toolkit.util.WcmString wsDisplayText, int value)
           
 void addListBoxItem(com.filenet.wcm.toolkit.util.WcmString wsDisplayText, java.lang.String sValue)
           
 void clear()
           
 void initialize()
           
 void render(java.io.Writer w)
           
 void renderBooleanSetting(java.io.Writer w, com.filenet.wcm.toolkit.util.WcmString columnText, java.lang.String fieldName, boolean currentValue, boolean defaultValue)
           
 void renderEndTable(java.io.Writer w)
           
 void renderHeaderWithListBox(java.io.Writer w, java.lang.String text)
           
 void renderMainHeader(java.io.Writer w, java.lang.String text)
           
 void renderMainHeader(java.io.Writer w, com.filenet.wcm.toolkit.util.WcmString wsText)
           
static void renderPassword(com.filenet.wcm.toolkit.server.base.WcmController controller, java.io.Writer w, com.filenet.wcm.toolkit.util.WcmString linkstr, com.filenet.wcm.toolkit.server.base.WcmUiModule parent, java.lang.String currentpassword, boolean passwordChanged)
           
static void renderSelectRoles(com.filenet.wcm.toolkit.server.base.WcmController controller, java.io.Writer w, java.lang.String pageId, java.util.Collection roles, com.filenet.wcm.toolkit.server.base.WcmUiModule parent)
           
static void renderSelectRoles(com.filenet.wcm.toolkit.server.base.WcmController controller, java.io.Writer w, java.lang.String pageId, java.util.Collection roles, com.filenet.wcm.toolkit.server.base.WcmUiModule parent, boolean readonly)
           
static void renderSelectRoles(com.filenet.wcm.toolkit.server.base.WcmController controller, java.io.Writer w, java.lang.String pageId, java.util.Collection roles, com.filenet.wcm.toolkit.server.base.WcmUiModule parent, com.filenet.wcm.toolkit.util.WcmString linkLabel)
           
static void renderSelectRoles(com.filenet.wcm.toolkit.server.base.WcmController controller, java.io.Writer w, java.lang.String pageId, java.util.Collection roles, com.filenet.wcm.toolkit.server.base.WcmUiModule parent, com.filenet.wcm.toolkit.util.WcmString linkLabel, boolean readonly)
           
static void renderSelectRoles(com.filenet.wcm.toolkit.server.base.WcmController controller, java.io.Writer w, java.lang.String pageId, java.util.Collection roles, com.filenet.wcm.toolkit.server.base.WcmUiModule parent, com.filenet.wcm.toolkit.util.WcmString linkLabel, boolean readonly, java.lang.String defaultColumn)
           
static void renderSelectRoles(com.filenet.wcm.toolkit.server.base.WcmController controller, java.io.Writer w, java.lang.String pageId, java.util.Collection roles, com.filenet.wcm.toolkit.server.base.WcmUiModule parent, com.filenet.wcm.toolkit.util.WcmString linkLabel, java.lang.String descriptionCssClass, com.filenet.wcm.toolkit.util.WcmString defaultRoleLabel, boolean readonly, java.lang.String defaultColumn)
           
 void renderSpacer(java.io.Writer w)
           
 void renderStartTable(java.io.Writer w)
           
 void renderSubHeader(java.io.Writer w, java.lang.String FirstTwoColumns)
           
 void renderSubHeader(java.io.Writer w, java.lang.String firstColumn, java.lang.String thirdColumn)
           
 void renderSubHeader(java.io.Writer w, java.lang.String firstColumn, java.lang.String thirdColumn, java.lang.String firstColumnStyle)
           
 void renderSubHeader(java.io.Writer w, java.lang.String firstColumn, java.lang.String thirdColumn, java.lang.String firstColumnStyle, java.lang.String imageURL, java.lang.String imageToolTip)
           
 void renderSubHeader(java.io.Writer w, java.lang.String firstColumn, java.lang.String thirdColumn, java.lang.String firstColumnStyle, java.lang.String imageURL, java.lang.String imageToolTip, java.lang.String trClass)
           
 void renderSubHeader(java.io.Writer w, com.filenet.wcm.toolkit.util.WcmString wsFirstTwoColumns)
           
 void renderSubHeader(java.io.Writer w, com.filenet.wcm.toolkit.util.WcmString wsFirstTwoColumns, com.filenet.wcm.toolkit.util.WcmString wsThirdColumn)
           
 void setAdditionalHtml(java.lang.String sHtml)
          Writes out the passed in html directly with no additional processing.
 void setAdditionalText(java.lang.String sText)
           
 void setDefaultColumnText(int value)
           
 void setDefaultColumnText(java.lang.String sText)
           
 void setDefaultColumnText(com.filenet.wcm.toolkit.util.WcmString wsText)
           
 void setDescriptionColumnText(java.lang.String sText)
           
 void setDescriptionColumnText(java.lang.String sText, boolean translateColumnText)
          Sets the text that is displayed in the description column; this is the left most column with descriptive text.
 void setDescriptionColumnText(com.filenet.wcm.toolkit.util.WcmString wsText)
           
 void setDescriptionColumnText(com.filenet.wcm.toolkit.util.WcmString wsText, boolean translateColumnText)
          Sets the text that is displayed in the description column; this is the left most column with descriptive text.
 void setDescriptionColumnVAlign(java.lang.String valign)
          Sets the vertical alignment to use for the description column; often there is a vertical list in the column to this columns right and it is desirable to keep this column top aligned with it.
 void setInputFieldName(java.lang.String sName)
           
 void setRenderDefaultsColumn(boolean on)
           
 void setRenderPasswordField(boolean on)
           
 void setRenderTextArea(boolean on)
           
 void setRequiredField(boolean requiredField)
          Sets whether the current field being rendered should be rendered with the "isRequired" icon (a red asterick).
 void setRequiredFieldColumn(boolean requiredFieldColumn)
          Sets whether or not there needs to be a required field column.
 void setSelectedListBoxItem(boolean value)
           
 void setSelectedListBoxItem(int value)
           
 void setSelectedListBoxItem(java.lang.String value)
           
 void setTextBoxValue(int value)
           
 void setTextBoxValue(long value)
           
 void setTextBoxValue(java.lang.String sValue)
           
 void setTextFieldSize(int textFieldSize)
           
 
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

wsYes

public static final com.filenet.wcm.toolkit.util.WcmString wsYes

wsNo

public static final com.filenet.wcm.toolkit.util.WcmString wsNo

sDescriptionColumn

protected java.lang.String sDescriptionColumn

sDefaultColumn

protected java.lang.String sDefaultColumn

sAdditionalText

protected java.lang.String sAdditionalText

sAdditionalHtml

protected java.lang.String sAdditionalHtml

sTextBoxValue

protected java.lang.String sTextBoxValue

sPasswordBoxValue

protected java.lang.String sPasswordBoxValue

listBoxItems

protected java.util.List listBoxItems

sSelectedListBoxItem

protected java.lang.String sSelectedListBoxItem

sInputFieldName

protected java.lang.String sInputFieldName

descriptionColumnVAlign

protected java.lang.String descriptionColumnVAlign

bRenderPasswordField

protected boolean bRenderPasswordField

bRenderTextArea

protected boolean bRenderTextArea

bRenderDefaultsColumn

protected boolean bRenderDefaultsColumn

requiredField

protected boolean requiredField

translateColumnText

protected boolean translateColumnText

requiredFieldColumn

protected boolean requiredFieldColumn

locale

protected java.util.Locale locale
Constructor Detail

WcmPreferenceSetting

public WcmPreferenceSetting()

WcmPreferenceSetting

public WcmPreferenceSetting(java.util.Locale locale)
Use this constructor and you don't have to register this module

Parameters:
locale -
Method Detail

initialize

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

clear

public void clear()

setTextFieldSize

public void setTextFieldSize(int textFieldSize)

setRenderDefaultsColumn

public void setRenderDefaultsColumn(boolean on)

setRenderTextArea

public void setRenderTextArea(boolean on)

setRenderPasswordField

public void setRenderPasswordField(boolean on)

setDescriptionColumnText

public void setDescriptionColumnText(com.filenet.wcm.toolkit.util.WcmString wsText)

setDescriptionColumnText

public void setDescriptionColumnText(java.lang.String sText)

setDescriptionColumnText

public void setDescriptionColumnText(com.filenet.wcm.toolkit.util.WcmString wsText,
                                     boolean translateColumnText)
Sets the text that is displayed in the description column; this is the left most column with descriptive text.

Parameters:
wsText - Text to render in the column.
translateColumnText - Set to true if this text need to be translated and encoded. Uses WcmEncodingUtil to accomplish this.

setDescriptionColumnText

public void setDescriptionColumnText(java.lang.String sText,
                                     boolean translateColumnText)
Sets the text that is displayed in the description column; this is the left most column with descriptive text.

Parameters:
sText - Text to render in the column.
translateColumnText - Set to true if this text need to be translated and encoded. Uses WcmEncodingUtil to accomplish this.

setDescriptionColumnVAlign

public void setDescriptionColumnVAlign(java.lang.String valign)
Sets the vertical alignment to use for the description column; often there is a vertical list in the column to this columns right and it is desirable to keep this column top aligned with it.

Parameters:
valign - Desired alignment to use ("top", "bottom", or "middle").

setDefaultColumnText

public void setDefaultColumnText(int value)

setDefaultColumnText

public void setDefaultColumnText(java.lang.String sText)

setDefaultColumnText

public void setDefaultColumnText(com.filenet.wcm.toolkit.util.WcmString wsText)

setAdditionalText

public void setAdditionalText(java.lang.String sText)

setAdditionalHtml

public void setAdditionalHtml(java.lang.String sHtml)
Writes out the passed in html directly with no additional processing.

Parameters:
sHtml - HTML to directly render.

setTextBoxValue

public void setTextBoxValue(java.lang.String sValue)

setTextBoxValue

public void setTextBoxValue(int value)

setTextBoxValue

public void setTextBoxValue(long value)

addListBoxItem

public void addListBoxItem(com.filenet.wcm.toolkit.util.WcmString wsDisplayText,
                           java.lang.String sValue)

addListBoxItem

public void addListBoxItem(java.lang.String sDisplayText,
                           java.lang.String sValue)

addListBoxItem

public void addListBoxItem(com.filenet.wcm.toolkit.util.WcmString wsDisplayText,
                           int value)

addListBoxItem

public void addListBoxItem(com.filenet.wcm.toolkit.util.WcmString wsDisplayText,
                           boolean value)

setSelectedListBoxItem

public void setSelectedListBoxItem(java.lang.String value)

setSelectedListBoxItem

public void setSelectedListBoxItem(int value)

setSelectedListBoxItem

public void setSelectedListBoxItem(boolean value)

setInputFieldName

public void setInputFieldName(java.lang.String sName)

setRequiredFieldColumn

public void setRequiredFieldColumn(boolean requiredFieldColumn)
                            throws java.lang.Exception
Sets whether or not there needs to be a required field column.

Parameters:
requiredFieldColumn - Set to true if a required field column is necessary. If any of the fields will be required then this needs to be true.
Throws:
java.lang.Exception - if render(Write w) has already been called; this method call needs to come first.

setRequiredField

public void setRequiredField(boolean requiredField)
                      throws java.lang.Exception
Sets whether the current field being rendered should be rendered with the "isRequired" icon (a red asterick).

Parameters:
requiredField - Set to true if field is required otherwise set to false.
Throws:
java.lang.Exception - if a required field column hasn't been turned on. See setRequiredFieldColumn(boolean).

renderBooleanSetting

public void renderBooleanSetting(java.io.Writer w,
                                 com.filenet.wcm.toolkit.util.WcmString columnText,
                                 java.lang.String fieldName,
                                 boolean currentValue,
                                 boolean defaultValue)
                          throws java.lang.Exception
Throws:
java.lang.Exception

renderStartTable

public void renderStartTable(java.io.Writer w)
                      throws java.lang.Exception
Throws:
java.lang.Exception

renderEndTable

public void renderEndTable(java.io.Writer w)
                    throws java.lang.Exception
Throws:
java.lang.Exception

renderSpacer

public void renderSpacer(java.io.Writer w)
                  throws java.lang.Exception
Throws:
java.lang.Exception

renderMainHeader

public void renderMainHeader(java.io.Writer w,
                             com.filenet.wcm.toolkit.util.WcmString wsText)
                      throws java.lang.Exception
Throws:
java.lang.Exception

renderMainHeader

public void renderMainHeader(java.io.Writer w,
                             java.lang.String text)
                      throws java.lang.Exception
Throws:
java.lang.Exception

renderSubHeader

public void renderSubHeader(java.io.Writer w,
                            java.lang.String FirstTwoColumns)
                     throws java.lang.Exception
Throws:
java.lang.Exception

renderSubHeader

public void renderSubHeader(java.io.Writer w,
                            com.filenet.wcm.toolkit.util.WcmString wsFirstTwoColumns)
                     throws java.lang.Exception
Throws:
java.lang.Exception

renderSubHeader

public void renderSubHeader(java.io.Writer w,
                            com.filenet.wcm.toolkit.util.WcmString wsFirstTwoColumns,
                            com.filenet.wcm.toolkit.util.WcmString wsThirdColumn)
                     throws java.lang.Exception
Throws:
java.lang.Exception

renderSubHeader

public void renderSubHeader(java.io.Writer w,
                            java.lang.String firstColumn,
                            java.lang.String thirdColumn)
                     throws java.lang.Exception
Throws:
java.lang.Exception

renderSubHeader

public void renderSubHeader(java.io.Writer w,
                            java.lang.String firstColumn,
                            java.lang.String thirdColumn,
                            java.lang.String firstColumnStyle)
                     throws java.lang.Exception
Throws:
java.lang.Exception

renderSubHeader

public void renderSubHeader(java.io.Writer w,
                            java.lang.String firstColumn,
                            java.lang.String thirdColumn,
                            java.lang.String firstColumnStyle,
                            java.lang.String imageURL,
                            java.lang.String imageToolTip)
                     throws java.lang.Exception
Throws:
java.lang.Exception

renderSubHeader

public void renderSubHeader(java.io.Writer w,
                            java.lang.String firstColumn,
                            java.lang.String thirdColumn,
                            java.lang.String firstColumnStyle,
                            java.lang.String imageURL,
                            java.lang.String imageToolTip,
                            java.lang.String trClass)
                     throws java.lang.Exception
Throws:
java.lang.Exception

renderSelectRoles

public static void renderSelectRoles(com.filenet.wcm.toolkit.server.base.WcmController controller,
                                     java.io.Writer w,
                                     java.lang.String pageId,
                                     java.util.Collection roles,
                                     com.filenet.wcm.toolkit.server.base.WcmUiModule parent,
                                     boolean readonly)
                              throws java.lang.Exception
Throws:
java.lang.Exception

renderSelectRoles

public static void renderSelectRoles(com.filenet.wcm.toolkit.server.base.WcmController controller,
                                     java.io.Writer w,
                                     java.lang.String pageId,
                                     java.util.Collection roles,
                                     com.filenet.wcm.toolkit.server.base.WcmUiModule parent)
                              throws java.lang.Exception
Throws:
java.lang.Exception

renderSelectRoles

public static void renderSelectRoles(com.filenet.wcm.toolkit.server.base.WcmController controller,
                                     java.io.Writer w,
                                     java.lang.String pageId,
                                     java.util.Collection roles,
                                     com.filenet.wcm.toolkit.server.base.WcmUiModule parent,
                                     com.filenet.wcm.toolkit.util.WcmString linkLabel)
                              throws java.lang.Exception
Throws:
java.lang.Exception

renderPassword

public static void renderPassword(com.filenet.wcm.toolkit.server.base.WcmController controller,
                                  java.io.Writer w,
                                  com.filenet.wcm.toolkit.util.WcmString linkstr,
                                  com.filenet.wcm.toolkit.server.base.WcmUiModule parent,
                                  java.lang.String currentpassword,
                                  boolean passwordChanged)
                           throws java.lang.Exception
Throws:
java.lang.Exception

renderSelectRoles

public static void renderSelectRoles(com.filenet.wcm.toolkit.server.base.WcmController controller,
                                     java.io.Writer w,
                                     java.lang.String pageId,
                                     java.util.Collection roles,
                                     com.filenet.wcm.toolkit.server.base.WcmUiModule parent,
                                     com.filenet.wcm.toolkit.util.WcmString linkLabel,
                                     boolean readonly,
                                     java.lang.String defaultColumn)
                              throws java.lang.Exception
Throws:
java.lang.Exception

renderSelectRoles

public static void renderSelectRoles(com.filenet.wcm.toolkit.server.base.WcmController controller,
                                     java.io.Writer w,
                                     java.lang.String pageId,
                                     java.util.Collection roles,
                                     com.filenet.wcm.toolkit.server.base.WcmUiModule parent,
                                     com.filenet.wcm.toolkit.util.WcmString linkLabel,
                                     java.lang.String descriptionCssClass,
                                     com.filenet.wcm.toolkit.util.WcmString defaultRoleLabel,
                                     boolean readonly,
                                     java.lang.String defaultColumn)
                              throws java.lang.Exception
Throws:
java.lang.Exception

renderSelectRoles

public static void renderSelectRoles(com.filenet.wcm.toolkit.server.base.WcmController controller,
                                     java.io.Writer w,
                                     java.lang.String pageId,
                                     java.util.Collection roles,
                                     com.filenet.wcm.toolkit.server.base.WcmUiModule parent,
                                     com.filenet.wcm.toolkit.util.WcmString linkLabel,
                                     boolean readonly)
                              throws java.lang.Exception
Throws:
java.lang.Exception

renderHeaderWithListBox

public void renderHeaderWithListBox(java.io.Writer w,
                                    java.lang.String text)
                             throws java.lang.Exception
Throws:
java.lang.Exception

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Throws:
java.lang.Exception


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