|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1) E10684-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXValue
org.apache.myfaces.trinidad.component.UIXEditableValue
org.apache.myfaces.trinidad.component.UIXSelectOne
oracle.adf.view.rich.component.rich.input.RichSelectOneListbox
public class RichSelectOneListbox
The selectOneListbox component creates a component which allows the user to select a single value from a list of items. The selectOneListbox 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.
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 events 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 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 |
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 |
PARTIAL_TRIGGERS_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
READ_ONLY_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 |
SIZE_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 |
UNSELECTED_LABEL_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.UIXSelectOne |
---|
REQUIRED_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, VALID_KEY, 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 |
---|
bindings |
Constructor Summary | |
---|---|
|
RichSelectOneListbox() Construct an instance of the RichSelectOneListbox. |
protected |
RichSelectOneListbox(java.lang.String rendererType) Construct an instance of the RichSelectOneListbox. |
Method Summary | |
---|---|
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. |
ClientListenerSet |
getClientListeners() Gets a set of client listeners. |
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 |
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[] |
getPartialTriggers() Gets the IDs of the components that should trigger a partial update. |
java.lang.String |
getShortDesc() Gets the short description of the component. |
int |
getSize() Gets the number of items that should be visible in the list. |
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. |
java.lang.String |
getUnselectedLabel() Gets the label for an additional item that indicates no selection has been made. |
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 |
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 |
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 |
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 |
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 |
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 |
setSize(int size) Sets the number of items that should be visible in the list. |
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 |
setUnselectedLabel(java.lang.String unselectedLabel) Sets the label for an additional item that indicates no selection has been made. |
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.UIXSelectOne |
---|
getRequiredMessageKey, validateValue |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXEditableValue |
---|
addValidator, addValueChangeListener, broadcast, compareValues, getConvertedValue, getRequiredMessageDetail, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, setImmediate, setLocalValueSet, setRequired, setRequiredMessageDetail, setSubmittedValue, setValid, setValidator, setValueChangeListener, 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, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent |
---|
addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree |
Methods inherited from class javax.faces.component.UIComponent |
---|
getContainerClientId |
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 |
---|
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey CHANGED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CHANGED_DESC_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey AUTO_SUBMIT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ACCESS_KEY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey HELP_TOPIC_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DISABLED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey LABEL_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey READ_ONLY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_REQUIRED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SIMPLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VALUE_PASS_THRU_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSELECTED_LABEL_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SIZE_KEY
public static final java.lang.String HELP_FACET
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public RichSelectOneListbox()
protected RichSelectOneListbox(java.lang.String rendererType)
Method Detail |
---|
public final javax.faces.component.UIComponent getHelp()
public final void setHelp(javax.faces.component.UIComponent helpFacet)
public final boolean isChanged()
public final void setChanged(boolean changed)
changed
- the new changed valuepublic final java.lang.String getChangedDesc()
public final void setChangedDesc(java.lang.String changedDesc)
changedDesc
- the new changedDesc valuepublic final boolean isAutoSubmit()
public final void setAutoSubmit(boolean autoSubmit)
autoSubmit
- the new autoSubmit valuepublic final char getAccessKey()
for
, if set (or this component itself, if it is a "non-simple" form element). For accessibility reasons, this functionality is not supported in screen reader mode. 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 7.0 will set focus when you press Alt+<accessKey>. Firefox 2.0 on some operating systems you press Alt+Shift+<accessKey>. Firefox 2.0 on other operating systems you press Control+<accessKey>. Refer to your browser's documentation for how it treats accessKey.
public final void setAccessKey(char accessKey)
for
, if set (or this component itself, if it is a "non-simple" form element). For accessibility reasons, this functionality is not supported in screen reader mode. 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 7.0 will set focus when you press Alt+<accessKey>. Firefox 2.0 on some operating systems you press Alt+Shift+<accessKey>. Firefox 2.0 on other operating systems you press Control+<accessKey>. Refer to your browser's documentation for how it treats accessKey.
accessKey
- the new accessKey valuepublic final java.lang.String getContentStyle()
public final void setContentStyle(java.lang.String contentStyle)
contentStyle
- the new contentStyle valuepublic final java.lang.String getHelpTopicId()
public final void setHelpTopicId(java.lang.String helpTopicId)
helpTopicId
- the new helpTopicId valuepublic final boolean isDisabled()
public final void setDisabled(boolean disabled)
disabled
- the new disabled valuepublic final java.lang.String getLabel()
public final void setLabel(java.lang.String label)
label
- the new label valuepublic final boolean isReadOnly()
public final void setReadOnly(boolean readOnly)
readOnly
- the new readOnly valuepublic final boolean isShowRequired()
public final void setShowRequired(boolean showRequired)
showRequired
- the new showRequired valuepublic final boolean isSimple()
public final void setSimple(boolean simple)
simple
- the new simple valuepublic final java.lang.String getInlineStyle()
public final void setInlineStyle(java.lang.String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final java.lang.String getStyleClass()
public final void setStyleClass(java.lang.String styleClass)
styleClass
- the new styleClass valuepublic final java.lang.String getShortDesc()
public final void setShortDesc(java.lang.String shortDesc)
shortDesc
- the new shortDesc valuepublic final java.util.Set<java.lang.String> getUnsecure()
public final void setUnsecure(java.util.Set<java.lang.String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value
@Deprecated
public final java.lang.String getCustomizationId()
@Deprecated
public final void setCustomizationId(java.lang.String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final java.util.Set getClientAttributes()
public final void setClientAttributes(java.util.Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final java.lang.String[] getPartialTriggers()
public final void setPartialTriggers(java.lang.String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic final boolean isValuePassThru()
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.
public final void setValuePassThru(boolean valuePassThru)
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.
valuePassThru
- the new valuePassThru valuepublic final java.lang.String getUnselectedLabel()
public final void setUnselectedLabel(java.lang.String unselectedLabel)
unselectedLabel
- the new unselectedLabel valuepublic final int getSize()
public final void setSize(int size)
size
- the new size valuepublic java.lang.String getFamily()
getFamily
in class org.apache.myfaces.trinidad.component.UIXSelectOne
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class org.apache.myfaces.trinidad.component.UIXSelectOne
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1) E10684-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |