UIGenericPicker (Alfresco 5.3.a-SNAPSHOT API)

java.lang.Object
- javax.faces.component.UIComponent
- - javax.faces.component.UIComponentBase
  - - javax.faces.component.UICommand
    - - org.alfresco.web.ui.common.component.UIGenericPicker

All Implemented Interfaces:

ActionSource, StateHolder
```
public class UIGenericPicker
extends UICommand
```
Author:

Kevin Roast

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UIGenericPicker.PickerEvent
Class representing the an action relevant to the Generic Selector component.

Nested Classes
Modifier and Type	Class and Description
`static class`	`UIGenericPicker.PickerEvent` Class representing the an action relevant to the Generic Selector component.

Field Summary
- Fields inherited from class javax.faces.component.UICommand
  COMPONENT_FAMILY, COMPONENT_TYPE

Constructor Summary

Constructors
Constructor and Description

UIGenericPicker()
Default constructor

Constructors
Constructor and Description
`UIGenericPicker()` Default constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`broadcast(FacesEvent event)`
`void`	`decode(FacesContext context)`
`void`	`encodeBegin(FacesContext context)`
`String`	`getAddButtonLabel()`
`String`	`getFamily()`
`int`	`getFilterIndex()`
`SelectItem[]`	`getFilterOptions()`
`boolean`	`getFilterRefresh()`
`int`	`getHeight()`
`boolean`	`getMultiSelect()`
`MethodBinding`	`getQueryCallback()`
`String`	`getSearchButtonLabel()`
`String[]`	`getSelectedResults()`
`boolean`	`getShowAddButton()`
`boolean`	`getShowContains()`
`boolean`	`getShowFilter()`
`int`	`getWidth()`
`void`	`restoreState(FacesContext context, Object state)`
`Object`	`saveState(FacesContext context)`
`void`	`setAddButtonLabel(String addButtonLabel)`
`void`	`setFilterRefresh(boolean filterRefresh)`
`void`	`setHeight(int height)`
`void`	`setMultiSelect(boolean multiSelect)`
`void`	`setQueryCallback(MethodBinding binding)`
`void`	`setSearchButtonLabel(String searchButtonLabel)`
`void`	`setShowAddButton(boolean showAddButton)`
`void`	`setShowContains(boolean showContains)`
`void`	`setShowFilter(boolean showFilter)`
`void`	`setWidth(int width)`

Methods inherited from class javax.faces.component.UICommand
addActionListener, getAction, getActionListener, getActionListeners, getValue, isImmediate, queueEvent, removeActionListener, setAction, setActionListener, setImmediate, setValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - UIGenericPicker
```
public UIGenericPicker()
```
    Default constructor
- Method Detail
  - getFamily
```
public String getFamily()
```
    Overrides:
    
    getFamily in class UICommand
    
    See Also:
    
    UIComponent.getFamily()
  - restoreState
```
public void restoreState(FacesContext context,
                         Object state)
```
    Specified by:
    
    restoreState in interface StateHolder
    
    Overrides:
    
    restoreState in class UICommand
    
    See Also:
    
    StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)
  - saveState
```
public Object saveState(FacesContext context)
```
    Specified by:
    
    saveState in interface StateHolder
    
    Overrides:
    
    saveState in class UICommand
    
    See Also:
    
    StateHolder.saveState(javax.faces.context.FacesContext)
  - decode
```
public void decode(FacesContext context)
```
    Overrides:
    
    decode in class UIComponentBase
    
    See Also:
    
    UIComponentBase.decode(javax.faces.context.FacesContext)
  - broadcast
```
public void broadcast(FacesEvent event)
               throws AbortProcessingException
```
    Overrides:
    
    broadcast in class UICommand
    
    Throws:
    
    AbortProcessingException
    
    See Also:
    
    UIComponentBase.broadcast(javax.faces.event.FacesEvent)
  - encodeBegin
```
public void encodeBegin(FacesContext context)
                 throws IOException
```
    Overrides:
    
    encodeBegin in class UIComponentBase
    
    Throws:
    
    IOException
    
    See Also:
    
    UIComponentBase.encodeBegin(javax.faces.context.FacesContext)
  - getFilterOptions
```
public SelectItem[] getFilterOptions()
```
    Returns:
    
    the filter options
  - getFilterIndex
```
public int getFilterIndex()
```
    Returns:
    
    current filter drop-down selected index value
  - getSearchButtonLabel
```
public String getSearchButtonLabel()
```
    Returns:
    
    Returns the searchButtonLabel.
  - setSearchButtonLabel
```
public void setSearchButtonLabel(String searchButtonLabel)
```
    Parameters:
    
    searchButtonLabel - The searchButtonLabel to set.
  - getAddButtonLabel
```
public String getAddButtonLabel()
```
    Returns:
    
    Returns the addButtonLabel.
  - setAddButtonLabel
```
public void setAddButtonLabel(String addButtonLabel)
```
    Parameters:
    
    addButtonLabel - The addButtonLabel to set.
  - getShowAddButton
```
public boolean getShowAddButton()
```
    Returns:
    
    Returns the showAddButton.
  - setShowAddButton
```
public void setShowAddButton(boolean showAddButton)
```
    Parameters:
    
    showAddButton - The showAddButton to set.
  - getShowContains
```
public boolean getShowContains()
```
    Returns:
    
    Returns the showContains.
  - setShowContains
```
public void setShowContains(boolean showContains)
```
    Parameters:
    
    showContains - The showContains to set.
  - getShowFilter
```
public boolean getShowFilter()
```
    Returns:
    
    Returns the showFilter.
  - setShowFilter
```
public void setShowFilter(boolean showFilter)
```
    Parameters:
    
    showFilter - The showFilter to set.
  - getFilterRefresh
```
public boolean getFilterRefresh()
```
    Returns:
    
    Returns the filterRefresh.
  - setFilterRefresh
```
public void setFilterRefresh(boolean filterRefresh)
```
    Parameters:
    
    filterRefresh - The filterRefresh to set.
  - getMultiSelect
```
public boolean getMultiSelect()
```
    Returns:
    
    true if multi select should be enabled.
  - setMultiSelect
```
public void setMultiSelect(boolean multiSelect)
```
    Parameters:
    
    multiSelect - Flag to determine whether multi select is enabled
  - getWidth
```
public int getWidth()
```
    Returns:
    
    Returns the width.
  - setWidth
```
public void setWidth(int width)
```
    Parameters:
    
    width - The width to set.
  - getHeight
```
public int getHeight()
```
    Returns:
    
    Returns the height.
  - setHeight
```
public void setHeight(int height)
```
    Parameters:
    
    height - The height to set.
  - getQueryCallback
```
public MethodBinding getQueryCallback()
```
    Returns:
    
    Returns the queryCallback.
  - setQueryCallback
```
public void setQueryCallback(MethodBinding binding)
```
    Parameters:
    
    binding - The queryCallback MethodBinding to set.
  - getSelectedResults
```
public String[] getSelectedResults()
```
    Returns:
    
    The selected results. An array of whatever string objects were attached to the SelectItem[] objects supplied as the result of the picker query.

Class UIGenericPicker

Nested Class Summary

Field Summary

Fields inherited from class javax.faces.component.UICommand

Constructor Summary

Method Summary

Methods inherited from class javax.faces.component.UICommand

Methods inherited from class javax.faces.component.UIComponentBase

Methods inherited from class java.lang.Object

Constructor Detail

UIGenericPicker

Method Detail

getFamily

restoreState

saveState

decode

broadcast

encodeBegin

getFilterOptions

getFilterIndex

getSearchButtonLabel

setSearchButtonLabel

getAddButtonLabel

setAddButtonLabel

getShowAddButton

setShowAddButton

getShowContains

setShowContains

getShowFilter

setShowFilter

getFilterRefresh

setFilterRefresh

getMultiSelect

setMultiSelect

getWidth

setWidth

getHeight

setHeight

getQueryCallback

setQueryCallback

getSelectedResults