rich:inplaceSelect inplaceSelect

Component identification parameters

Name | Value
--- | ---
component-type | org.richfaces.InplaceSelect
component-class | org.richfaces.component.html.HtmlInplaceSelect
component-family | org.richfaces.InplaceSelect
renderer-type | org.richfaces.renderkit.InplaceSelectRenderer
tag-class | org.richfaces.taglib.InplaceSelectTag

## Creating the Component with a Page Tag

Here is a simple example of how the component can be used on a page:

Example:

    ...
    <rich:inplaceSelect value="#{bean.inputValue}">
        <f:selectItem itemValue="1" itemLabel="factory"/>
    </rich:inplaceSelect>
    ...

## Creating the Component Dynamically Using Java

Example:

    import org.richfaces.component.html.inplaceSelect;
    ...
    HtmlInpaceSelect myInplaceSelect = new InplaceSelect();
    ...

## Details of Usage

The "value" attribute is a value-binding expression for the current value of the component.

The <rich:inplaceSelect> component has three functional states:

- View state displays default label with the value taken from "value" or "defaultLabel" attributes.

  If the initial value of the "value" attribute is "null" or empty string the "defaultLabel" attribute is used to define default label.

  Example:

      ...
      <rich:inplaceSelect value="#{bean.value}" defaultLabel="click to edit">
          <f:selectItems value="#{bean.selectItems}" />
      </rich:inplaceSelect>
      ...

  In the example above the "value" attribute is not initialized therefore "`click to edit`" text, that "defaultLabel", contains is displayed.

  This is the result:

  View state

- Edit state - select representation to allow value edit

  Edit state

- Changed state - value representation after it was changed

  Changed state

You can form the list of the options using <f:selectItem/> and <f:selectItems/> JSF components.

Please, see the example below.

Example:

    ...
    <rich:inplaceSelect value="#{bean.inputValue}" defaultLabel="click to edit">
        <f:selectItems  value="#{bean.selectItems}"/>
        <f:selectItem itemValue="1" itemLabel="factory"/>
        <f:selectItem itemValue="2" itemLabel="newspaper"/>
    </rich:inplaceSelect>
    ...

In the example above the value of the selected item is available via "value" attribute.

The "editEvent" attribute provides an option to assign an JavaScript action that initiates the change of the state from view to edit. The default value is "onclick".

Example:

    ...
    <rich:inplaceSelect value="#{bean.inputValue}" defaultLabel="Double Click to edit" editEvent="ondblclick">
        <f:selectItems value="#{demo.selectItems}" />
    </rich:inplaceSelect>
    ...

The <rich:inplaceSelect> component provides specific event attributes:

- "oneditactivation" fired on edit state activation

- "oneditactivated" fired when edit state is activated

- "onviewactivation" fired on view state activation

- "onviewactivated" fired after the component is changed to representation state

Example:

    ...
    <rich:inplaceSelect value="#{bean.inputValue}" oneditactivation="if (!confirm('Are you sure you want to change the value?')){return false;}">
        <f:selectItems value="#{demo.selectItems}" />
    </rich:inplaceSelect>
    ...

The given code illustrates how "oneditactivation" attribute works, namely when the state is being changed from view to edit, a confirmation window with a message `"Are you sure you want to change value?"` comes up.

To prevent opening the drop-down list by default, once edit state is activated, set the "openOnEdit" attribute to "false". The default value is "true".

Example:

    ...
    <rich:inplaceSelect value="#{bean.inputValue}" showControls="true" openOnEdit="false">
        <f:selectItems  value="#{bean.selectItems}"/>
    </rich:inplaceSelect>
    ...

This is the result:

The "openOnEdit" attribute usage

Nowever, if you want to confirm the data saving explicitly you can use the "showControls" attribute, which makes "Save" and "Cancel" buttons (displayed as icons) appear next to the input field. Edit state can be deactivated by pressing "Esc" key. An option in the drop-drown list can be also selected by pressing "Enter".

Example:

    ...
    <rich:inplaceSelect value="#{bean.inputValue}" showControls="true">
        <f:selectItems  value="#{bean.selectItems}"/>
    </rich:inplaceSelect>
    ...

This is the result:

The "showControls" attribute usage

You can also position the controls relatively to the input field, by means of

- The "controlsHorizontalPosition" attribute with "left", "right" and "center" definitions

- The "controlsVerticalPosition " attribute with "bottom" and "top" definitions

Example:

    ...
    <rich:inplaceSelect value="#{bean.inputValue}" controlsHorizontalPosition="left" controlsVerticalPosition="center" showControls="true">
        <f:selectItems  value="#{bean.selectItems}"/>
    </rich:inplaceSelect>
    ...

This is the result:

Controls positioning

It is also possible to use "controls" facet in order to replace the default controls with facets content. See the example below.

Please, see the example.

Example:

    ...
    <rich:inplaceSelect value="#{bean.inputValue}" showControls="true">
        <f:facet name="controls">
            <button onclick="#{rich:component('inplaceSelect')}.save();" type="button">Save</button>
            <button onclick="#{rich:component('inplaceSelect')}.cancel();" type="button">Cancel</button>
        </f:facet>
        <f:selectItems  value="#{bean.selectItems}"/>
    </rich:inplaceSelect>
    ...

This is the result:

"controls" facet usage

Note:

The "controls"facet also implies using "showControls" attribute and it has to be defined as "true".

The <rich:inplaceSelect> component could be rendered with <span> or <div> elements to display its value. In order to change default <span> output, use the "layout" attribute with "block" value.

The <rich:inplaceSelect> component supports standard "tabindex" attribute. When the component gets focus the edit mode is activated and drop-down list is opened.

The "selectWidth", "minSelectWidth" and "maxSelectWidth" attributes are provided to specify the width, minimal width and maximal width for the input element respectively.

In order to specify the height and width parameters for the list items of the component, you can use "listHeight" and " listWidth" attributes.

## JavaScript API

JavaScript API

Function | Description
--- | ---
edit() | Changes the state to edit
cancel() | Changes its state to the previous one before editing (changed or view)
save() | Changes its state to changed with a new value
getValue() | Gets the current value
setValue(newValue) | Sets the current value and name

## Facets

Facets

Facet name | Description
--- | ---
controls | Defines the contols contents. Related attributes are "saveControlIcon" and "cancelControlIcon"

## Look-and-Feel Customization

For skinnability implementation, the components use a style class redefinition method. Default style classes are mapped on skin parameters.

There are two ways to redefine the appearance of all <rich:inplaceSelect> components at once:

- Redefine the corresponding skin parameters

- Add to your style sheets style classes used by a <rich:inplaceSelect> component

## Skin Parameters Redefinition

Skin parameters redefinition for view state

Skin parameters | CSS properties
--- | ---
editorBackgroundColor | background-color
generaTextColor | border-bottom-color

Skin parameters redefinition for input field in edit state

Skin parameters | CSS properties
--- | ---
editBackgroundColor | background-color
panelBorderColor | border-color

Skin parameters redefinition for control

Skin parameters | CSS properties
--- | ---
tabBackgroundColor | background-color
panelBorderColor | border-color

Skin parameters redefinition for pressed control

Skin parameters | CSS properties
--- | ---
tabBackgroundColor | background-color
panelBorderColor | border-color

Skin parameters redefinition for list

Skin parameters | CSS properties
--- | ---
editBackgroundColor | background-color
panelBorderColor | border-color

Skin parameters redefinition for selected item

Skin parameters | CSS properties
--- | ---
headerTextColor | color
headerBackgroundColor | background-color
headerBackgroundColor | border-color

## Definition of Custom Style Classes

On the screenshot there are classes names that define styles for component elements.

Classes names

Class name for the view state

Class name | Description
--- | ---
rich-inplace-select-view | Defines styles for the select view

Class name for the input field in edit state

Class name | Description
--- | ---
rich-inplace-select-field | Defines styles for the select field

Class name for the control

Class name | Description
--- | ---
rich-inplace-select-control | Defines styles for the select control
rich-inplace-select-control-press | Defines styles for the pressed select control

Class name for the list

Class name | Description
--- | ---
rich-inplace-select-list-decoration | Defines styles for a wrapper <table> element of an inplaceSelect

Classes names for the selected item

Class name | Description
--- | ---
rich-inplace-select-selected-item | Defines styles for the selected item

Classes names for the shadow

Class name | Description
--- | ---
rich-inplace-select-shadow-tl | Defines styles for the top-left shadow
rich-inplace-select-shadow-tr | Defines styles for the top-right shadow
rich-inplace-select-shadow-bl | Defines styles for the bottom-left shadow
rich-inplace-select-shadow-br | Defines styles for the bottom-right shadow

In order to redefine styles for all <rich:inplaceSelect> components on a page using CSS, it's enough to create classes with the same names (possible classes could be found in the tables above) and define necessary properties in them.

Example:

    ...
    .rich-inplace-select-list-decoration{
        background-color: #ecf4fe;
    }

    ...

This is the result:

Redefinition styles with predefined classes

In the shown example the background color for list is changed.

It's aslo possible to change styles of a particular <rich:inplaceSelect> component. In this case you should create own style classes and use them in corresponding <rich:inplaceSelect> styleClass attributes. An example is placed below:

Example:

    ...
    .myClass {
        background-color:#bed6f8;
        font-style:italic;}
    ...

The "viewClass" attribute for <rich:inplaceSelect> is defined as it's shown in the example below:

Example:

    <rich:inplaceSelect value="click to edit" viewClass="myClass"/>

This is a result:

Modificaton of a look and feel with own classes and styleClass attributes

As it could be seen on the picture above, the font style and background color in view state is changed.

## Relevant Resources Links

On the component Live Demo page you can see the example of <rich:inplaceSelect> usage and sources for the given example.