Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 2 (11.1.2.3.0)
E17488-04


oracle.adf.view.rich.component.rich.input
Class RichSelectManyChoice

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by org.apache.myfaces.trinidad.component.UIXComponent
          extended by org.apache.myfaces.trinidad.component.UIXComponentBase
              extended by org.apache.myfaces.trinidad.component.UIXValue
                  extended by org.apache.myfaces.trinidad.component.UIXEditableValue
                      extended by org.apache.myfaces.trinidad.component.UIXSelectMany
                          extended by oracle.adf.view.rich.component.rich.input.RichSelectManyChoice

All Implemented Interfaces:
java.util.EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class RichSelectManyChoice
extends org.apache.myfaces.trinidad.component.UIXSelectMany
implements javax.faces.component.behavior.ClientBehaviorHolder

The selectManyChoice component creates a menu-style component, which allows the user to select multiple values from a dropdown list of items. The selectManyChoice component contains any number of <f:selectItem>, <f:selectItems>, or <af:selectItem> components, each of which represents an available option that the user may select.

The attributes "disabled", "immediate", "readOnly", "required", "requiredMessageDetail", "value" are not settable from the client for security reasons. The "disabled" attribute can be set on the client if the "unsecure" attribute is set accordingly.

<section name="Geometry_Management"> <html:ul> <html:li>This component cannot be stretched by a parent layout component.</html:li> <html:li>This component does not stretch its children.</html:li> </html:ul> </section>

Events:

Type Phases Description
javax.faces.event.ValueChangeEvent Process
Validations
Apply
Request
Values
The valueChange event is delivered when the value attribute is changed.
org.apache.myfaces.trinidad.event.AttributeChangeEvent Invoke
Application
Apply
Request
Values
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing.

Field Summary
static org.apache.myfaces.trinidad.bean.PropertyKey ACCESS_KEY_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey AUTO_SUBMIT_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CHANGED_DESC_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CHANGED_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
           
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static java.lang.String CONTENT_DELIVERY_IMMEDIATE
           
static org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_DELIVERY_KEY
           
static java.lang.String CONTENT_DELIVERY_LAZY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_STYLE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
          Deprecated. 
static org.apache.myfaces.trinidad.bean.PropertyKey DISABLED_KEY
           
static java.lang.String EDITABLE_ALWAYS
           
static java.lang.String EDITABLE_INHERIT
           
static org.apache.myfaces.trinidad.bean.PropertyKey EDITABLE_KEY
           
static java.lang.String EDITABLE_ON_ACCESS
           
static java.lang.String HELP_FACET
           
static org.apache.myfaces.trinidad.bean.PropertyKey HELP_TOPIC_ID_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey LABEL_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey LABEL_STYLE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey LAZY_SELECTED_LABELS_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey READ_ONLY_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SELECT_ALL_VISIBLE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SHOW_REQUIRED_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SIMPLE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
           
static org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey VALUE_PASS_THRU_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
           

 

Fields inherited from class org.apache.myfaces.trinidad.component.UIXSelectMany
REQUIRED_MESSAGE_ID, UNSUPPORTED_MODEL_TYPE_MESSAGE_ID

 

Fields inherited from class org.apache.myfaces.trinidad.component.UIXEditableValue
CONVERSION_MESSAGE_ID, IMMEDIATE_KEY, LOCAL_VALUE_SET_KEY, REQUIRED_KEY, REQUIRED_MESSAGE_DETAIL_KEY, SUBMITTED_VALUE_KEY, TRINIDAD_BEAN_VALIDATION_AVAILABLE, TRINIDAD_EMPTY_VALUES_AS_NULL_PARAM_NAME, VALID_KEY, VALIDATE_EMPTY_FIELDS_PARAM_NAME, VALIDATOR_KEY, VALIDATORS_KEY, VALUE_CHANGE_LISTENER_KEY

 

Fields inherited from class org.apache.myfaces.trinidad.component.UIXValue
CONVERTER_KEY, VALUE_KEY

 

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

 

Fields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

 

Constructor Summary
  RichSelectManyChoice()
          Construct an instance of the RichSelectManyChoice.
protected RichSelectManyChoice(java.lang.String rendererType)
          Construct an instance of the RichSelectManyChoice.

 

Method Summary
 void addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
           
 char getAccessKey()
          Gets a character used to gain quick access to the form element specified by the for, if set (or this component itself, if it is a "non-simple" form element).
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
           
 java.lang.String getChangedDesc()
          Gets the text commonly used by user agents to display tooltip text on the changed indicator icon.
 java.util.Set getClientAttributes()
          Gets a set of client attribute names.
 java.util.Map<java.lang.String,java.util.List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
           
 ClientListenerSet getClientListeners()
          Gets a set of client listeners.
 java.lang.String getContentDelivery()
          Gets
 java.lang.String getContentStyle()
          Gets the style of the content piece of the component.
 java.lang.String getCustomizationId()
          Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
 java.lang.String getDefaultEventName()
           
 java.lang.String getEditable()
          Gets the editable look and feel to use for input components.
 java.util.Collection<java.lang.String> getEventNames()
           
 java.lang.String getFamily()
           
 javax.faces.component.UIComponent getHelp()
          This facet is deprecated, helpTopicId should be used for providing help.
 java.lang.String getHelpTopicId()
          Gets the id used to look up a topic in a helpProvider.
 java.lang.String getInlineStyle()
          Gets the CSS styles to use for this component.
 java.lang.String getLabel()
          Gets the label of the component.
 java.lang.String getLabelStyle()
          Gets the CSS styles to use for the label of this component.
 java.lang.String[] getLazySelectedLabels()
          Gets
 java.lang.String[] getPartialTriggers()
          Gets the IDs of the components that should trigger a partial update.
 java.lang.String getShortDesc()
          Gets the short description of the component.
 java.lang.String getStyleClass()
          Gets a CSS style class to use for this component.
 java.util.Set<java.lang.String> getUnsecure()
          Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
 boolean isAutoSubmit()
          Gets an attribute which if set to TRUE on a form element, the component will automatically submit when an appropriate action takes place (a click, text change, etc.).
 boolean isChanged()
          Gets an attribute which if set to true, the changed indicator icon will be displayed on the component.
 boolean isClientComponent()
          Gets whether a client-side component will be generated.
 boolean isDisabled()
          Gets whether the element is disabled.
 boolean isReadOnly()
          Gets whether the control is displayed as an editable field or as an output-style text control.
 boolean isSelectAllVisible()
          Gets whether the select-all option is visible.
 boolean isShowRequired()
          Gets whether the associated control displays a visual indication of required user input.
 boolean isSimple()
          Gets a boolean value that controls whether the component provides label support; when set to "true", the component will not display the label (these may be ignored: label, labelAndAccessKey, accessKey, showRequired, help facet) and may use simpler layout primitives.
 boolean isValuePassThru()
          Gets whether or not the values are passed through to the client.
 boolean isVisible()
          Gets the visibility of the component.
 void setAccessKey(char accessKey)
          Sets a character used to gain quick access to the form element specified by the for, if set (or this component itself, if it is a "non-simple" form element).
 void setAutoSubmit(boolean autoSubmit)
          Sets an attribute which if set to TRUE on a form element, the component will automatically submit when an appropriate action takes place (a click, text change, etc.).
 void setChanged(boolean changed)
          Sets an attribute which if set to true, the changed indicator icon will be displayed on the component.
 void setChangedDesc(java.lang.String changedDesc)
          Sets the text commonly used by user agents to display tooltip text on the changed indicator icon.
 void setClientAttributes(java.util.Set clientAttributes)
          Sets a set of client attribute names.
 void setClientComponent(boolean clientComponent)
          Sets whether a client-side component will be generated.
 void setClientListeners(ClientListenerSet clientListeners)
          Sets a set of client listeners.
 void setContentDelivery(java.lang.String contentDelivery)
          Sets
 void setContentStyle(java.lang.String contentStyle)
          Sets the style of the content piece of the component.
 void setCustomizationId(java.lang.String customizationId)
          Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
 void setDisabled(boolean disabled)
          Sets whether the element is disabled.
 void setEditable(java.lang.String editable)
          Sets the editable look and feel to use for input components.
 void setHelp(javax.faces.component.UIComponent helpFacet)
          This facet is deprecated, helpTopicId should be used for providing help.
 void setHelpTopicId(java.lang.String helpTopicId)
          Sets the id used to look up a topic in a helpProvider.
 void setInlineStyle(java.lang.String inlineStyle)
          Sets the CSS styles to use for this component.
 void setLabel(java.lang.String label)
          Sets the label of the component.
 void setLabelStyle(java.lang.String labelStyle)
          Sets the CSS styles to use for the label of this component.
 void setLazySelectedLabels(java.lang.String[] lazySelectedLabels)
          Sets
 void setPartialTriggers(java.lang.String[] partialTriggers)
          Sets the IDs of the components that should trigger a partial update.
 void setReadOnly(boolean readOnly)
          Sets whether the control is displayed as an editable field or as an output-style text control.
 void setSelectAllVisible(boolean selectAllVisible)
          Sets whether the select-all option is visible.
 void setShortDesc(java.lang.String shortDesc)
          Sets the short description of the component.
 void setShowRequired(boolean showRequired)
          Sets whether the associated control displays a visual indication of required user input.
 void setSimple(boolean simple)
          Sets a boolean value that controls whether the component provides label support; when set to "true", the component will not display the label (these may be ignored: label, labelAndAccessKey, accessKey, showRequired, help facet) and may use simpler layout primitives.
 void setStyleClass(java.lang.String styleClass)
          Sets a CSS style class to use for this component.
 void setUnsecure(java.util.Set<java.lang.String> unsecure)
          Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
 void setValuePassThru(boolean valuePassThru)
          Sets whether or not the values are passed through to the client.
 void setVisible(boolean visible)
          Sets the visibility of the component.

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXSelectMany
compareValues, getRequiredMessageKey, isEmpty, validateValue

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXEditableValue
addValidator, addValueChangeListener, broadcast, getConvertedValue, getRequiredMessageDetail, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, setImmediate, setLocalValueSet, setRequired, setRequiredMessageDetail, setSubmittedValue, setValid, setValidator, setValueChangeListener, shouldInterpretEmptyStringSubmittedValuesAsNull, shouldValidateEmptyFields, updateModel, validate

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXValue
getConverter, getLocalValue, getValue, setConverter, setValue

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, subscribeToEvent, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent
addPartialTarget, clearCachedClientIds, clearCachedClientIds, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree

 

Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Methods inherited from interface javax.faces.component.ValueHolder
getConverter, getLocalValue, getValue, setConverter, setValue

 

Field Detail

EDITABLE_INHERIT

public static final java.lang.String EDITABLE_INHERIT
See Also:
Constant Field Values

EDITABLE_ALWAYS

public static final java.lang.String EDITABLE_ALWAYS
See Also:
Constant Field Values

EDITABLE_ON_ACCESS

public static final java.lang.String EDITABLE_ON_ACCESS
See Also:
Constant Field Values

CONTENT_DELIVERY_IMMEDIATE

public static final java.lang.String CONTENT_DELIVERY_IMMEDIATE
See Also:
Constant Field Values

CONTENT_DELIVERY_LAZY

public static final java.lang.String CONTENT_DELIVERY_LAZY
See Also:
Constant Field Values

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

CHANGED_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CHANGED_KEY

CHANGED_DESC_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CHANGED_DESC_KEY

AUTO_SUBMIT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey AUTO_SUBMIT_KEY

ACCESS_KEY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ACCESS_KEY_KEY

CONTENT_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_STYLE_KEY

HELP_TOPIC_ID_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey HELP_TOPIC_ID_KEY

DISABLED_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISABLED_KEY

LABEL_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey LABEL_KEY

LABEL_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey LABEL_STYLE_KEY

READ_ONLY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey READ_ONLY_KEY

SHOW_REQUIRED_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_REQUIRED_KEY

SIMPLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SIMPLE_KEY

INLINE_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY

SHORT_DESC_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY

UNSECURE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY

VISIBLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY

CUSTOMIZATION_ID_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
Deprecated. 

CLIENT_COMPONENT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY

CLIENT_ATTRIBUTES_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY

PARTIAL_TRIGGERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY

CLIENT_LISTENERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY

VALUE_PASS_THRU_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VALUE_PASS_THRU_KEY

EDITABLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey EDITABLE_KEY

LAZY_SELECTED_LABELS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey LAZY_SELECTED_LABELS_KEY

CONTENT_DELIVERY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_DELIVERY_KEY

SELECT_ALL_VISIBLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SELECT_ALL_VISIBLE_KEY

HELP_FACET

public static final java.lang.String HELP_FACET
See Also:
Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

Constructor Detail

RichSelectManyChoice

public RichSelectManyChoice()
Construct an instance of the RichSelectManyChoice.

RichSelectManyChoice

protected RichSelectManyChoice(java.lang.String rendererType)
Construct an instance of the RichSelectManyChoice.

Method Detail

getHelp

public final javax.faces.component.UIComponent getHelp()
This facet is deprecated, helpTopicId should be used for providing help. This is a no-op for form components.

setHelp

public final void setHelp(javax.faces.component.UIComponent helpFacet)
This facet is deprecated, helpTopicId should be used for providing help. This is a no-op for form components.

isChanged

public final boolean isChanged()
Gets an attribute which if set to true, the changed indicator icon will be displayed on the component.
Returns:
the new changed value

setChanged

public final void setChanged(boolean changed)
Sets an attribute which if set to true, the changed indicator icon will be displayed on the component.
Parameters:
changed - the new changed value

getChangedDesc

public final java.lang.String getChangedDesc()
Gets the text commonly used by user agents to display tooltip text on the changed indicator icon. Default value is "Changed". The behavior of the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips.
Returns:
the new changedDesc value

setChangedDesc

public final void setChangedDesc(java.lang.String changedDesc)
Sets the text commonly used by user agents to display tooltip text on the changed indicator icon. Default value is "Changed". The behavior of the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips.
Parameters:
changedDesc - the new changedDesc value

isAutoSubmit

public final boolean isAutoSubmit()
Gets an attribute which if set to TRUE on a form element, the component will automatically submit when an appropriate action takes place (a click, text change, etc.). Since autoSubmit is a partial submit, also submitted and re-rendered are any other components with partialTriggers pointing to this component.
Returns:
the new autoSubmit value

setAutoSubmit

public final void setAutoSubmit(boolean autoSubmit)
Sets an attribute which if set to TRUE on a form element, the component will automatically submit when an appropriate action takes place (a click, text change, etc.). Since autoSubmit is a partial submit, also submitted and re-rendered are any other components with partialTriggers pointing to this component.
Parameters:
autoSubmit - the new autoSubmit value

getAccessKey

public final char getAccessKey()
Gets a character used to gain quick access to the form element specified by the for, if set (or this component itself, if it is a "non-simple" form element). If the same access key appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.

This attribute is sometimes referred to as the "mnemonic".

Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer will set focus when you press Alt+<accessKey>. Firefox sets focus on some operating systems when you press Alt+Shift+<accessKey>. Firefox on other operating systems sets focus when you press Control+<accessKey>. Refer to your browser's documentation for how it treats access keys.

Returns:
the new accessKey value

setAccessKey

public final void setAccessKey(char accessKey)
Sets a character used to gain quick access to the form element specified by the for, if set (or this component itself, if it is a "non-simple" form element). If the same access key appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.

This attribute is sometimes referred to as the "mnemonic".

Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer will set focus when you press Alt+<accessKey>. Firefox sets focus on some operating systems when you press Alt+Shift+<accessKey>. Firefox on other operating systems sets focus when you press Control+<accessKey>. Refer to your browser's documentation for how it treats access keys.

Parameters:
accessKey - the new accessKey value

getContentStyle

public final java.lang.String getContentStyle()
Gets the style of the content piece of the component. You can style width by setting this attribute like this: width: 100px. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute.
Returns:
the new contentStyle value

setContentStyle

public final void setContentStyle(java.lang.String contentStyle)
Sets the style of the content piece of the component. You can style width by setting this attribute like this: width: 100px. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute.
Parameters:
contentStyle - the new contentStyle value

getHelpTopicId

public final java.lang.String getHelpTopicId()
Gets the id used to look up a topic in a helpProvider.
Returns:
the new helpTopicId value

setHelpTopicId

public final void setHelpTopicId(java.lang.String helpTopicId)
Sets the id used to look up a topic in a helpProvider.
Parameters:
helpTopicId - the new helpTopicId value

isDisabled

public final boolean isDisabled()
Gets whether the element is disabled. Unlike a readonly component, a disabled component is unable to receive focus. If the component has the potential to have a scrollbar, and you want the user to be able to scroll through the component's text or values, use the 'readOnly' attribute, not the 'disabled' attribute.
Returns:
the new disabled value

setDisabled

public final void setDisabled(boolean disabled)
Sets whether the element is disabled. Unlike a readonly component, a disabled component is unable to receive focus. If the component has the potential to have a scrollbar, and you want the user to be able to scroll through the component's text or values, use the 'readOnly' attribute, not the 'disabled' attribute.
Parameters:
disabled - the new disabled value

getLabel

public final java.lang.String getLabel()
Gets the label of the component. If you want the label to appear above the control, use a panelFormLayout.
Returns:
the new label value

setLabel

public final void setLabel(java.lang.String label)
Sets the label of the component. If you want the label to appear above the control, use a panelFormLayout.
Parameters:
label - the new label value

getLabelStyle

public final java.lang.String getLabelStyle()
Gets the CSS styles to use for the label of this component. The labelStyle is a set of CSS styles that are applied to the label DOM element of the component. This allows a label to be styled without requiring a new skin definition.
Returns:
the new labelStyle value

setLabelStyle

public final void setLabelStyle(java.lang.String labelStyle)
Sets the CSS styles to use for the label of this component. The labelStyle is a set of CSS styles that are applied to the label DOM element of the component. This allows a label to be styled without requiring a new skin definition.
Parameters:
labelStyle - the new labelStyle value

isReadOnly

public final boolean isReadOnly()
Gets whether the control is displayed as an editable field or as an output-style text control. Unlike a disabled component, a readonly component is able to receive focus.
Returns:
the new readOnly value

setReadOnly

public final void setReadOnly(boolean readOnly)
Sets whether the control is displayed as an editable field or as an output-style text control. Unlike a disabled component, a readonly component is able to receive focus.
Parameters:
readOnly - the new readOnly value

isShowRequired

public final boolean isShowRequired()
Gets whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the "showRequired" attribute must be false for the visual indication not to be displayed. An example of when it can be desirable to use the showRequired property is if you have a field that is initially empty and is required only if some other field on the page is touched.
Returns:
the new showRequired value

setShowRequired

public final void setShowRequired(boolean showRequired)
Sets whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the "showRequired" attribute must be false for the visual indication not to be displayed. An example of when it can be desirable to use the showRequired property is if you have a field that is initially empty and is required only if some other field on the page is touched.
Parameters:
showRequired - the new showRequired value

isSimple

public final boolean isSimple()
Gets a boolean value that controls whether the component provides label support; when set to "true", the component will not display the label (these may be ignored: label, labelAndAccessKey, accessKey, showRequired, help facet) and may use simpler layout primitives. One of the usecases can be when the component is used in repeatable elements like in table, for-each etc., where label is not required.
Returns:
the new simple value

setSimple

public final void setSimple(boolean simple)
Sets a boolean value that controls whether the component provides label support; when set to "true", the component will not display the label (these may be ignored: label, labelAndAccessKey, accessKey, showRequired, help facet) and may use simpler layout primitives. One of the usecases can be when the component is used in repeatable elements like in table, for-each etc., where label is not required.
Parameters:
simple - the new simple value

getInlineStyle

public final java.lang.String getInlineStyle()
Gets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.
Returns:
the new inlineStyle value

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)
Sets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.
Parameters:
inlineStyle - the new inlineStyle value

getStyleClass

public final java.lang.String getStyleClass()
Gets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.
Returns:
the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)
Sets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.
Parameters:
styleClass - the new styleClass value

getShortDesc

public final java.lang.String getShortDesc()
Gets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.
Returns:
the new shortDesc value

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)
Sets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.
Parameters:
shortDesc - the new shortDesc value

getUnsecure

public final java.util.Set<java.lang.String> getUnsecure()
Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute. Note that when you are able to set a property on the client, you will be allowed to by using the the .setProperty('attribute', newValue) method, but not the .setXXXAttribute(newValue) method. For example, if you have unsecure="disabled", then on the client you can use the method .setProperty('disabled', false), while the method .setDisabled(false) will not work and will provide a javascript error that setDisabled is not a function.
Returns:
the new unsecure value

setUnsecure

public final void setUnsecure(java.util.Set<java.lang.String> unsecure)
Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute. Note that when you are able to set a property on the client, you will be allowed to by using the the .setProperty('attribute', newValue) method, but not the .setXXXAttribute(newValue) method. For example, if you have unsecure="disabled", then on the client you can use the method .setProperty('disabled', false), while the method .setDisabled(false) will not work and will provide a javascript error that setDisabled is not a function.
Parameters:
unsecure - the new unsecure value

isVisible

public final boolean isVisible()
Gets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.
Returns:
the new visible value

setVisible

public final void setVisible(boolean visible)
Sets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.
Parameters:
visible - the new visible value

getCustomizationId

@Deprecated
public final java.lang.String getCustomizationId()
Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
Gets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
Returns:
the new customizationId value

setCustomizationId

@Deprecated
public final void setCustomizationId(java.lang.String customizationId)
Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
Sets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
Parameters:
customizationId - the new customizationId value

isClientComponent

public final boolean isClientComponent()
Gets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.
Returns:
the new clientComponent value

setClientComponent

public final void setClientComponent(boolean clientComponent)
Sets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.
Parameters:
clientComponent - the new clientComponent value

getClientAttributes

public final java.util.Set getClientAttributes()
Gets a set of client attribute names.
Returns:
the new clientAttributes value

setClientAttributes

public final void setClientAttributes(java.util.Set clientAttributes)
Sets a set of client attribute names.
Parameters:
clientAttributes - the new clientAttributes value

getPartialTriggers

public final java.lang.String[] getPartialTriggers()
Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.
Returns:
the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)
Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.
Parameters:
partialTriggers - the new partialTriggers value

getClientListeners

public final ClientListenerSet getClientListeners()
Gets a set of client listeners.
Returns:
the new clientListeners value

setClientListeners

public final void setClientListeners(ClientListenerSet clientListeners)
Sets a set of client listeners.
Parameters:
clientListeners - the new clientListeners value

isValuePassThru

public final boolean isValuePassThru()
Gets whether or not the values are passed through to the client. When valuePassThru is false the value and the options' values are converted to indexes before being sent to the client. Therefore, when valuePassThru is false, there is no need to write your own converter when you are using custom Objects as your values and/or options.

If you need to know the actual values on the client-side, then you can set valuePassThru to true. This will pass the values through to the client, using your custom converter if it is available; a custom converter is needed if you are using custom objects. For drag and drop it is recommended to set valuePassThru to true for both the drag source and drop target since values are usually required on the client for drag and drop operations.

The default is false.

Returns:
the new valuePassThru value

setValuePassThru

public final void setValuePassThru(boolean valuePassThru)
Sets whether or not the values are passed through to the client. When valuePassThru is false the value and the options' values are converted to indexes before being sent to the client. Therefore, when valuePassThru is false, there is no need to write your own converter when you are using custom Objects as your values and/or options.

If you need to know the actual values on the client-side, then you can set valuePassThru to true. This will pass the values through to the client, using your custom converter if it is available; a custom converter is needed if you are using custom objects. For drag and drop it is recommended to set valuePassThru to true for both the drag source and drop target since values are usually required on the client for drag and drop operations.

The default is false.

Parameters:
valuePassThru - the new valuePassThru value

getEditable

public final java.lang.String getEditable()
Gets the editable look and feel to use for input components. 'always' indicates that the input component should always look editable. 'onAccess' indicates that the input will only look editable when accessed (hover, focus). 'inherit' indicates that we want to use the component parent's setting. None of the ancestor components define 'always' or 'onAccess', then 'always' will be used.
Returns:
the new editable value

setEditable

public final void setEditable(java.lang.String editable)
Sets the editable look and feel to use for input components. 'always' indicates that the input component should always look editable. 'onAccess' indicates that the input will only look editable when accessed (hover, focus). 'inherit' indicates that we want to use the component parent's setting. None of the ancestor components define 'always' or 'onAccess', then 'always' will be used.
Parameters:
editable - the new editable value

getLazySelectedLabels

public final java.lang.String[] getLazySelectedLabels()
Gets

An array of strings that are initially shown in the box when contentDelivery=lazy, these will be concatenated by the selectManyChoice

If the array length is 1, and the string is "_ALL_", the localized string for "All" will be used, for example in English the word 'All' will appear, in French the word "Tout" will appear, etc.

Whether or not lazySelectedLabels is available the value attribute will still be called on the component.

Returns:
the new lazySelectedLabels value

setLazySelectedLabels

public final void setLazySelectedLabels(java.lang.String[] lazySelectedLabels)
Sets

An array of strings that are initially shown in the box when contentDelivery=lazy, these will be concatenated by the selectManyChoice

If the array length is 1, and the string is "_ALL_", the localized string for "All" will be used, for example in English the word 'All' will appear, in French the word "Tout" will appear, etc.

Whether or not lazySelectedLabels is available the value attribute will still be called on the component.

Parameters:
lazySelectedLabels - the new lazySelectedLabels value

getContentDelivery

public final java.lang.String getContentDelivery()
Gets

whether the selectable items are delivered with the initial page. The legal values are:

There are several limitations when using contentDelivery is "lazy".

Returns:
the new contentDelivery value

setContentDelivery

public final void setContentDelivery(java.lang.String contentDelivery)
Sets

whether the selectable items are delivered with the initial page. The legal values are:

There are several limitations when using contentDelivery is "lazy".

Parameters:
contentDelivery - the new contentDelivery value

isSelectAllVisible

public final boolean isSelectAllVisible()
Gets whether the select-all option is visible.
Returns:
the new selectAllVisible value

setSelectAllVisible

public final void setSelectAllVisible(boolean selectAllVisible)
Sets whether the select-all option is visible.
Parameters:
selectAllVisible - the new selectAllVisible value

getDefaultEventName

public java.lang.String getDefaultEventName()
Specified by:
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
getDefaultEventName in class org.apache.myfaces.trinidad.component.UIXComponentBase

getEventNames

public java.util.Collection<java.lang.String> getEventNames()
Specified by:
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

getClientBehaviors

public java.util.Map<java.lang.String,java.util.List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
Specified by:
getClientBehaviors in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
getClientBehaviors in class org.apache.myfaces.trinidad.component.UIXComponentBase

addClientBehavior

public void addClientBehavior(java.lang.String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)
Specified by:
addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
addClientBehavior in class org.apache.myfaces.trinidad.component.UIXComponentBase

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class org.apache.myfaces.trinidad.component.UIXSelectMany

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
Overrides:
getBeanType in class org.apache.myfaces.trinidad.component.UIXSelectMany

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 2 (11.1.2.3.0)
E17488-04


Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved.