Oracle Fusion Middleware Tag Reference for Oracle ADF Faces
11g Release 2 (11.1.2.0.0)

E17491-02

<af:inputComboboxListOfValues>

af:inputComboboxListOfValues inputComboboxListOfValues input combobox list of values

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.

Note: 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.

Data Exchange Mechanism

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.

Geometry Management

Screen Shot(s)


inputListOfValues screenshot
An inputComboBoxListOfValues component in a simple form. When the user clicks the dropdown arrow a picklist will appear.


inputListOfValues screenshot 2
An expanded inputComboBoxListOfValues component. User can select a row from the picklist or click "Search" to query for an item.

Code Example(s)

<af:inputComboboxListOfValues label="Ename" 
                              id="idInputComboboxListOfValues" 
                              binding="#{editor.component}" 
                              value="#{demoComboboxLOV.ename}" 
                              autoSubmit="true" 
                              popupTitle="Search and Select: Ename" 
                              searchDesc="Choose a name" 
                              validator="#{demoComboboxLOV.validate}"  
                              createPopupId="popupId"
                              model="#{demoComboboxLOV.listOfValuesModel}"
                              returnPopupDataValue=#{demoComboboxLOV.returnPopupDataValue}"
                              columns="45" />
   

Events

Type Phases Description
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 tabbing-out of either of the above components with a non null value set, and 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.
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.

Supported Facets

Name Description
context Location for contextual information. A contextInfo component is expected.
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. Command components added to this facet are only considered rendered when the dropdown popup is visible. Action events can only be queued on command components within this facet while the dropdown is disclosed.
help This facet is deprecated, helpTopicId should be used for providing help. This is a no-op for form components.
searchContent Content in the Search and Select popup dialog.

Attributes

Name Type Supports EL? Description
accessKey char Yes 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.

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.
autoComplete String Yes Valid Values: on, off

whether previous values of text fields in the form should be remembered and offered for auto completion.
autoSubmit boolean Yes Default Value: false

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.
autoTab boolean Yes Default Value: false

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.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 Default Value: false

an attribute which if set to true, the changed indicator icon will be displayed on the component.
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.
clientComponent boolean Yes Default Value: false

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.
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. 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.
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 Default Value: false

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.
editMode String Yes Valid Values: input, select
Default Value: input

the mode that controls how the user specifies a value. This attribute is only applicable when the 'readOnly' attribute is set to false.
  • input: this mode allows the user to type in a value as well as browse and select from a list of available values.
  • select: this mode allows the user only to browse and select from a list of available values.
editable String Yes Valid Values: inherit, always, onAccess
Default Value: inherit

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.
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:
  • Must not be a zero-length String.
  • First character must be an ASCII letter (A-Za-z) or an underscore ('_').
  • Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').
immediate boolean Yes Default Value: false

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. 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.
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' .
labelStyle String Yes 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.
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 Default Value: false

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 Default Value: true

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). If you want to change a component's rendered attribute from false to true using PPR, set the partialTrigger attribute of its parent component so the parent refreshes and in turn will render this component.
required boolean Yes Default Value: false

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.

Parameters:

  • {0} the label that identifies the component
resultsTableColumnStretching String Yes Valid Values: last, none, blank
Default Value: last

Indicates what kind of stretching you want applied to the columns of results table in search and select dialog.The default value is last which stretches the last column to fill up any unused space.If you want to have an empty blank column be automatically inserted and have it stretch (so the row background colors will span the entire width of the table), use the "blank" option. Note that row headers and frozen columns will not be stretched because doing so could easily leave the user unable to access the scrollable data body of the table.
Not supported on the following renderkits: org.apache.myfaces.trinidad.core
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.
returnPopupDataValue Object Yes an attribute for returning the set value in custom popup by the user in listOfValues component.
returnPopupListener javax.el.MethodExpression Only EL a method reference to a ReturnPopupListener (called in response to a ReturnPopupEvent).
searchDesc String Yes used to override the search description. The search description appears in the tooltip when user does a mouseover on the Search icon. By default this value will be 'Search: ' followed by the label name. If a searchDesc is specified, that value is used instead.
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. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.
showRequired boolean Yes Default Value: false

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 Default Value: false

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'.
unsecure java.util.Set Yes 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.
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 its previous value).
visible boolean Yes Default Value: true

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