UIComponent class: oracle.adf.view.rich.component.rich.input.RichInputComboboxListOfValues
Component type: oracle.adf.RichInputComboboxListOfValues
The inputComboboxListOfValues component allows a user to open a choice list and select from a list of values, in order to populate the LOV field (and possibly other fields) on a page.
Users can either select a value from the list in the dropdown panel or click the "Search..." link at the bottom of the panel to launch the "Search and Select" dialog. The dialog enables users to search for specific values and select the desired value that should go into the LOV field on the base page. The choice list when opened could display various items in the following order with separators between each (if applicable).
The list of options (favorites and the full list) are displayed in a tabular format inside the drop down panel. The values for every row and column of the table is typically stamped using the outputText component.
When the value is selected either from dropdown or from search and select dialog, the value gets pushed to the model irrespective of the autoSubmit property on the component.
Furthermore, just like the inputListOfValues component, the inputComboBoxListOfValues components provides a mechanism to facilitate exchange of data between a base page and the drop down list and the base page and the "Search and Select" dialog. This is handled through the model (or managed bean). Data updates to any fields besides the LOV field, on the base page, is acheived through PPR. When the user selects a row in the drop down panel, the data is returned as a List of objects for the selected rows (where each object is the rowData for a selected row). Currently the dropdown panel only allows selecting a single row. The List of objects are available on the ReturnPopupEvent, that is queued after a selection is made in the dropdown panel. Developers need to implement following listener to successfully complete the data exchange between the inputComboBoxListOfValues and the dropdown panel.
Developers need to implement following three listeners to successfully complete the data exchange between the "Search and Select" dialog and the LOV field (and possibly other fields) on the base page. The "Search and Select" dialog is launched when choosing the "Search..." option in the dropdown panel and a LaunchPopupEvent is queued.
|oracle.adf.view.rich.event.LaunchPopupEvent||Invoke Application||LaunchPopupEvent is delivered when a user's action on an input component results in the launching of a popup dialog. For example, clicking the search icon on the inputListOfValues component or the "Search..." entry at the bottom of the drop down panel of the inputComboboxListOfValues component or or tabbing-out of either of the above components with autoSumit set to "true" will result in the queueing and broadcasting of LaunchPopupEvent on the input*ListOfValues component.|
|oracle.adf.view.rich.event.ReturnPopupDataEvent||Invoke Application,Apply Request Values||Deprecated, will be removed in the future release|
|oracle.adf.view.rich.event.ReturnPopupEvent||Invoke Application||The ReturnPopupEvent is delivered after data for it has been provided by the ReturnPopupDataListener.|
Apply Request Values
|The valueChange event is delivered when the value attribute is changed.|
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.|
|customActions||Allows user to specify custom entries in the choice list (drop down panel). It can be one commandLink or multiple commandLinks that are wrapped in a group component. It is the developer's responsibility to wire up the action for the custom commandLink to, say, a popup dialog.|
|help||This facet is deprecated, helpTopicId should be used for providing help. This is a no-op for form components.|
|accessKey||char||Yes||a character used to gain quick access to the form element specified by the
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.
|attributeChangeListener||javax.el.MethodExpression||Only EL||a method reference to an attribute change listener. 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.|
|autoSubmit||boolean||Yes||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.). Also submitted are any other components with partialTriggers pointing to this component.|
|autoTab||boolean||Yes||an attribute which if set to TRUE, tells the component to automatically tab to the next focusable, when the maxlength for the current component has been reached.|
|binding||oracle.adf.view.rich.component.<wbr/>rich.input.RichInputComboboxListOfValues||Only EL||an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.|
|changed||boolean||Yes||an attribute which if set to true, the changed indicator icon will be displayed on the component. This value defaults to false.|
|changedDesc||String||Yes||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.|
|columns||int||Yes||the size of the text control specified by the number of characters shown. The default value depends on the browser.|
|contentStyle||String||Yes||the style of the content piece of the component. You can style width by setting this attribute like this: width: 100px.|
|converter||javax.faces.convert.Converter||Yes||a converter object|
|createPopupId||String||Yes||the id of the user-defined popup component relative to this component (accounting for NamingContainers). If this attribute is supplied, an af:toolbar with af:commandToolbarButton will be created internally, which will be displayed as create icon in the Search and Select dialog. Clicking the button launches the user-defined popup component.
If the developer has added a dialog within the popup, then the decision to refresh the table is made by the component intelligently(table will be refreshed on pressing Ok button in the dialog). If the developer has not added a dialog to the popup, then the table will be refreshed always.
Identifiers are relative to the component, and must account for NamingContainers. You can use a single colon to start the search from the root, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container and begin the search from there, ":::" will pop out of two naming containers and begin the search from there, etc.
|customizationId||String||Yes||This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.|
|disabled||boolean||Yes||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.|
|helpTopicId||String||Yes||the id used to look up a topic in a helpProvider.|
|id||String||No||the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML:
|immediate||boolean||Yes||whether the value is converted and validated immediately in the Apply Request Values phase, or is handled in the Process Validators phase, the default. By default, values are converted and validated together in the Process Validators phase. However, if you need access to the value of a component during Apply Request Values - for example, if you need to get the value from an actionListener on an immediate commandButton - then setting this to "immediate" makes that possible.|
|inlineStyle||String||Yes||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. 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.|
|items||java.util.List||Yes||a list of data for the live content inside the drop down panel of the inputComboboxListOfValues component.|
|label||String||Yes||the label of the component. If you want the label to appear above the control, use a panelFormLayout.|
|labelAndAccessKey||String||Yes||an attribute that will simultaneously set both the "label"and "accessKey" attributes from a single value, using the conventional ampersand notation. For example, setting this attribute to "T&ext" will set the label to "Text" and the access key to 'e' .|
|launchPopupListener||javax.el.MethodExpression||Only EL||a method reference to a LaunchPopupListener (called in response to a LaunchPopupEvent).|
|maximumLength||int||Yes||the maximum number of characters per line that can be entered into the text control.|
|model||oracle.adf.view.rich.model.ListOfValuesModel||Yes||A ListOfValuesModel object that represents the model for the LOV component. The ListOfValuesModel currently provides methods for use within the LOV component and in addition, to retrieve a QueryModel and TableModel in order to to display a table and/or a query component (which are then used to search and select a value for the LOV component). For details, please refer to the Javadocs for oracle.adf.view.rich.model.ListOfValuesModel|
|partialTriggers||String||Yes||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.|
|popupTitle||String||Yes||the title of the Search and Select popup dialog.|
|readOnly||boolean||Yes||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.|
|recentItems||java.util.List||Yes||a customized list of options that is part of a "Favorites" list. The recent items list is displayed before the list of items and can be a list of the most recently used (MRU) items in the dataset.|
|rendered||boolean||Yes||whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client).|
|required||boolean||Yes||whether a non-null, non-empty value must be entered. If false, validators will not be executed when the value is null or empty.|
|requiredMessageDetail||String||Yes||the message to be displayed, if 'required' validation fails.
|returnPopupDataListener||javax.el.MethodExpression||Only EL||A method reference to a ReturnPopupDataListener (called in response to a ReturnPopupDataEvent). The attrbite is deprecated and will be removed in the future release.|
|returnPopupListener||javax.el.MethodExpression||Only EL||a method reference to a ReturnPopupListener (called in response to a ReturnPopupEvent).|
|searchDesc||String||Yes||the search information that appears in the tooltip when user does a mouseover on the Search icon.|
|shortDesc||String||Yes||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.|
|showRequired||boolean||Yes||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.|
|simple||boolean||Yes||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.|
|styleClass||String||Yes||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'.|
|validator||javax.faces.el.MethodBinding||Only EL||a method reference to a validator method|
|value||Object||Yes||the value of the component. If the EL binding for the "value" points to a bean property with a getter but no setter, and this is an editable component, the component will be rendered in read-only mode.|
|valueChangeListener||javax.faces.el.MethodBinding||Only EL||a method reference to a value change listener|
|var||String||No||the name of the EL variable used to reference each row inside the drop down panel. Once this component has completed rendering, this variable is removed (or reverted back to it's previous value).|
|visible||boolean||Yes||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.
Not supported on the following renderkits: org.apache.myfaces.trinidad.core