Oracle Fusion Middleware Tag Reference for Oracle ADF Faces 12c (12.2.1.4.0) E81455-03

# <af:inputListOfValues>

af:inputListOfValues inputListOfValues input list of values

UIComponent class: oracle.adf.view.rich.component.rich.input.RichInputListOfValues
Component type: oracle.adf.RichInputListOfValues

The inputListOfValues component allows users to select from a large list of values to help populate the LOV field (and possibly other fields) on a page. This component is used in situations where the list of values to display is too large.

In addition to rendering an inputText component, the inputListOfValues also renders a "Search" icon. Clicking the icon lauches a "Search and Select" dialog that enables the user to find an option that goes into the LOV field on the base page.

Note: When the value is selected from search and select dialog, the value gets pushed to the model irrespective of the autoSubmit property on the component.

## Data Exchange Mechanism

The mechanism to exchange data between a base page and the popup dialog should be handled through the model (or managed bean). Developers need to implement following three listeners to successfully complete the data exchange.

- launchPopupListener: Called in response to a "LaunchPopupEvent", this listener can be used to access any data, from fields in the base page, that is required by the model (or managed bean). The data on the base page is typically used
  - to determine if the "Search and Select" dialog needs to be launched
  - to enable fields in the dialog to bind to
  - to filter the list of data that is shown in the dialog
- returnPopupDataListener: Called in response to the "ReturnPopupDataEvent", The event is queued when the user selects a value from search and select dialog.
- returnPopupListener: Called in response to the "ReturnPopupEvent", this listener can be used to retrieve the returned values from ReturnPopupEvent and update base fields (among other things).

## Geometry Management

- This component cannot be stretched by a parent layout component.
- This component does not display any children so there are no child stretching capabilities.

## Screen Shot(s)

An inputListOfValues component in a simple form. When the user clicks the magnifying glass, a popup appears where they can select a value.
An expanded inputListOfValues component. The user can click on one of the rows to select it, or click "Search..." to query for a row.

## Code Example(s)

    <af:inputListOfValues label="Ename"
                          id="idInputLOV"
                          value="#{demoLOV.ename}"
                          autoSubmit="true"
                          popupTitle="Search and Select: Ename"
                          searchDesc="Choose a name"
                          model="#{demoLOV.listOfValuesModel}"
                          returnPopupDataValue=#{demoLOV.returnPopupDataValue}"
                          validator="#{demoLOV.validate}" />

## 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 the the popup/dialog data is packaged and returned.
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.
help | This facet is deprecated, helpTopicId should be used for providing help. This is a no-op for form components.
resultsTable | Table component to be used in the Search and Select dialog. Supports sub classes of RichTable. Table columns should not be configured as they are auto generated by LOV. Only one of 'searchContent' or 'resultsTable' facet can be configured.
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. For browser backward compatibility, "on" and "off" are kept as property values. But it also accepts arbitrary values like on, off, phone-number, billing-address, address-line1, username, etc. which specify how the browser should populate the given form field based on previous user inputs to similar fields.
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.RichInputListOfValues | 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.
characterCountBy | String | Yes | the method to count surrogate pair characters. codeUnit counts surrogate pair characters as 2 logical characters. codePoint counts surrogate pair characters as 1 logical character. This is used for determining if a value exceeds the maximumLength attribute.
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. For the components outputText and outputFormatted, setting the clientComponent to true will render id attribute for the html DOM. This ID attribute can alternatively be generated by setting oracle.adf.view.rich.SUPPRESS_IDS to "auto" in web.xml.
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 a button 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. Every component may be named by a component identifier that must conform to the following rules: They must start with a letter (as defined by the Character.isLetter() method) or underscore ( _ ). Subsequent characters must be letters (as defined by the Character.isLetter() method), digits as defined by the Character.isDigit() method, dashes ( - ), or underscores ( _ ). To minimize the size of responses generated by JavaServer Faces, it is recommended that component identifiers be as short as possible. If a component has been given an identifier, it must be unique in the namespace of the closest ancestor to that component that is a NamingContainer (if any).
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.
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 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.
placeholder | String | Yes | Text to be displayed in the input component when a value is not present.
popupTitle | String | Yes | the title of the Search and Select popup dialog.
protectionKey | String | Yes | protection key for this component
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.
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, required validation logic 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).
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. The shortDesc text may be used in two different ways, depending on the component. For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute. shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this 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 and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.
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.
usage | String | Yes | Valid Values: auto, text, search Default Value: auto The usage attribute will set the type of the input to allow for different html types (such as search, email, tel etc). Currently, auto will default to text but may in the future conditionally default to some other type. Html types with strict input validation rules (ex: date, number) should be avoided or used with discretion, since they can potentially interfere with the normal functioning of the component and converter.
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
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