com.ibm.xsp.component
Class UISelectManyEx

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by javax.faces.component.UIInput
                  extended by javax.faces.component.UISelectMany
                      extended by com.ibm.xsp.component.UISelectManyEx
All Implemented Interfaces:
FacesInputComponent, FacesDojoComponent, ThemeControl, javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder
Direct Known Subclasses:
UISelectListbox, XspSelectManyCheckbox

public class UISelectManyEx
extends javax.faces.component.UISelectMany
implements FacesInputComponent, ThemeControl, FacesDojoComponent


Nested Class Summary
 
Nested classes/interfaces inherited from class javax.faces.component.UIComponentBase
javax.faces.component.UIComponentBase.AggregatedIterator, javax.faces.component.UIComponentBase.UnmodifiableIterator
 
Nested classes/interfaces inherited from class javax.faces.component.UIComponent
javax.faces.component.UIComponent.StateMap, javax.faces.component.UIComponent.StateMapEntry
 
Field Summary
 
Fields inherited from class javax.faces.component.UISelectMany
COMPONENT_FAMILY, COMPONENT_TYPE, INVALID_MESSAGE_ID
 
Fields inherited from class javax.faces.component.UIInput
CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID
 
Fields inherited from class javax.faces.component.UIComponentBase
EMPTY_ITERATOR
 
Fields inherited from class javax.faces.component.UIComponent
_xspStateId
 
Constructor Summary
UISelectManyEx()
           
 
Method Summary
 void addDojoAttribute(DojoAttribute attribute)
          Add a dojo attribute to the set associated with this property.
 void encodeBegin(javax.faces.context.FacesContext context)
           
 void encodeEnd(javax.faces.context.FacesContext context)
           
 java.lang.Object getDefaultValue()
          Similar to UIInputEx.getDefaultValue() except the default value must be a list, array, or newline-separated string, containing one or more values from the label/value pairs allowed as values for this control.
 java.util.List<DojoAttribute> getDojoAttributes()
           Return the value of the dojoAttributes property.
 java.lang.String getDojoType()
           Return the value of the dojoType property.
 java.lang.String getRequiredMessage()
           
 java.lang.String getStyleKitFamily()
          The styleKitFamily is basically the default themeId, to use if the "themeId" property is not set on this control instance in the XPage source.
 java.lang.Object getValue()
           
 boolean isDisableClientSideValidation()
          Check if client side validation is disabled.
 boolean isDisableModifiedFlag()
          The modified support is the mechanism in the Notes Client where if an input control contains a value and the user closes the XPage tab, they will be prompted like: The XPage has been modified, Save, Discard, Cancel? As part of that mechanism, each input control has a "disableModifiedFlag" property to allow that control to opt-out of the modified support, so for example if you have a search field, where you don't normally save the searched text to a document, you would exclude that search field from the modified support, so a value in that search field will not cause the Save/Discard dialog to appear.
 boolean isDisableValidators()
          Check if the validators should be disabled for this control.
 boolean isRequired()
           
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setDefaultValue(java.lang.Object defaultValue)
           Set the default value for this control..
 void setDisableClientSideValidation(boolean disableClientSideValidation)
           
 void setDisableModifiedFlag(boolean disableModifiedFlag)
           
 void setDisableValidators(boolean disableValidators)
           
 void setDojoAttributes(java.util.List<DojoAttribute> dojoAttributes)
           Set the value of the dojoAttributes property.
 void setDojoType(java.lang.String dojoType)
           Set the value of the dojoType property.
 void setRequired(boolean required)
           
 void setValueBinding(java.lang.String name, javax.faces.el.ValueBinding binding)
           
 void validate(javax.faces.context.FacesContext context)
           
protected  void validateValue(javax.faces.context.FacesContext context, java.lang.Object newValue)
           
 
Methods inherited from class javax.faces.component.UISelectMany
compareValues, getFamily, getSelectedValues, getValueBinding, setSelectedValues
 
Methods inherited from class javax.faces.component.UIInput
addValidator, addValueChangeListener, broadcast, decode, getConvertedValue, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, setImmediate, setLocalValueSet, setSubmittedValue, setValid, setValidator, setValue, setValueChangeListener, updateModel
 
Methods inherited from class javax.faces.component.UIOutput
getConverter, getLocalValue, setConverter
 
Methods inherited from class javax.faces.component.UIComponentBase
_xspCleanTransientData, _xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient
 
Methods inherited from class javax.faces.component.UIComponent
_xspGetStateId, _xspGetStateMap, _xspRestoreAttribute, _xspRestoreState, _xspSaveState, invokeOnComponent, isVisitable, markInitialState, setControlState, visitTree
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.faces.component.ValueHolder
getConverter, getLocalValue, setConverter
 

Constructor Detail

UISelectManyEx

public UISelectManyEx()
Method Detail

getStyleKitFamily

public java.lang.String getStyleKitFamily()
Description copied from interface: ThemeControl
The styleKitFamily is basically the default themeId, to use if the "themeId" property is not set on this control instance in the XPage source. For example, "InputField.EditBox" is used for most Edit Box controls. See Domino/xsp/nsf/themes/webstandard.theme for more examples.

The implementation may return different values depending on the configuration of the current control, for example the Button control returns a different value and looks different when it is configured as a cancel button.

Specified by:
getStyleKitFamily in interface ThemeControl
Returns:
a non-null themeId corresponding to the configuration for this type of control in a theme file.

setDefaultValue

public void setDefaultValue(java.lang.Object defaultValue)

Set the default value for this control..


getDefaultValue

public java.lang.Object getDefaultValue()
Similar to UIInputEx.getDefaultValue() except the default value must be a list, array, or newline-separated string, containing one or more values from the label/value pairs allowed as values for this control.

Return the default value of this control.


isDisableModifiedFlag

public boolean isDisableModifiedFlag()
Description copied from interface: FacesInputComponent
The modified support is the mechanism in the Notes Client where if an input control contains a value and the user closes the XPage tab, they will be prompted like: The XPage has been modified, Save, Discard, Cancel? As part of that mechanism, each input control has a "disableModifiedFlag" property to allow that control to opt-out of the modified support, so for example if you have a search field, where you don't normally save the searched text to a document, you would exclude that search field from the modified support, so a value in that search field will not cause the Save/Discard dialog to appear. This method checks the value of that input control property in the XPage, and also, if the value is not set for the individual input control, checks the property on the XPage root control UIViewRootEx.isEnableModifiedFlag().

Specified by:
isDisableModifiedFlag in interface FacesInputComponent
Returns:
See Also:
FacesInputComponent.isDisableModifiedFlag()

setDisableModifiedFlag

public void setDisableModifiedFlag(boolean disableModifiedFlag)

isDisableClientSideValidation

public boolean isDisableClientSideValidation()
Description copied from interface: FacesInputComponent
Check if client side validation is disabled.

Specified by:
isDisableClientSideValidation in interface FacesInputComponent
Returns:
See Also:
FacesInputComponent.isDisableClientSideValidation()

setDisableClientSideValidation

public void setDisableClientSideValidation(boolean disableClientSideValidation)

isDisableValidators

public boolean isDisableValidators()
Description copied from interface: FacesInputComponent
Check if the validators should be disabled for this control.

Specified by:
isDisableValidators in interface FacesInputComponent
Returns:
See Also:
FacesInputComponent.isDisableValidators()

setDisableValidators

public void setDisableValidators(boolean disableValidators)

getDojoType

public java.lang.String getDojoType()

Return the value of the dojoType property. Contents:

Sets the default Dojo Type used to create this control in the browser.

Specified by:
getDojoType in interface FacesDojoComponent
See Also:
FacesDojoComponent.getDojoType()

setDojoType

public void setDojoType(java.lang.String dojoType)

Set the value of the dojoType property.


getDojoAttributes

public java.util.List<DojoAttribute> getDojoAttributes()

Return the value of the dojoAttributes property. Contents:

A list of Dojo attributes

Specified by:
getDojoAttributes in interface FacesDojoComponent
See Also:
FacesDojoComponent.getDojoAttributes()

addDojoAttribute

public void addDojoAttribute(DojoAttribute attribute)
Add a dojo attribute to the set associated with this property.

Parameters:
action -
See Also:
FacesDojoComponent.getDojoAttributes()

setDojoAttributes

public void setDojoAttributes(java.util.List<DojoAttribute> dojoAttributes)

Set the value of the dojoAttributes property.


saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class javax.faces.component.UIInput

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class javax.faces.component.UIInput

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws java.io.IOException
Overrides:
encodeBegin in class javax.faces.component.UIComponentBase
Throws:
java.io.IOException

encodeEnd

public void encodeEnd(javax.faces.context.FacesContext context)
               throws java.io.IOException
Overrides:
encodeEnd in class javax.faces.component.UIComponentBase
Throws:
java.io.IOException

getValue

public java.lang.Object getValue()
Specified by:
getValue in interface javax.faces.component.ValueHolder
Overrides:
getValue in class javax.faces.component.UIOutput

setValueBinding

public void setValueBinding(java.lang.String name,
                            javax.faces.el.ValueBinding binding)
Overrides:
setValueBinding in class javax.faces.component.UISelectMany

validate

public void validate(javax.faces.context.FacesContext context)
Overrides:
validate in class javax.faces.component.UIInput

validateValue

protected void validateValue(javax.faces.context.FacesContext context,
                             java.lang.Object newValue)
Overrides:
validateValue in class javax.faces.component.UISelectMany

setRequired

public void setRequired(boolean required)
Specified by:
setRequired in interface javax.faces.component.EditableValueHolder
Overrides:
setRequired in class javax.faces.component.UIInput

isRequired

public boolean isRequired()
Specified by:
isRequired in interface javax.faces.component.EditableValueHolder
Overrides:
isRequired in class javax.faces.component.UIInput

getRequiredMessage

public java.lang.String getRequiredMessage()
Overrides:
getRequiredMessage in class javax.faces.component.UIInput