BaseAjaxItemPicker (Alfresco Content Services Community WAR 6.0.2-ea API)

java.lang.Object
- javax.faces.component.UIComponent
- - javax.faces.component.UIComponentBase
  - - javax.faces.component.UIOutput
    - - javax.faces.component.UIInput
      - org.alfresco.web.ui.repo.component.BaseAjaxItemPicker

All Implemented Interfaces:

javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

Direct Known Subclasses:

UIAjaxCategoryPicker, UIAjaxFilePicker, UIAjaxFolderPicker, UIAjaxTagPicker
```
public abstract class BaseAjaxItemPicker
extends javax.faces.component.UIInput
```
Base class for the JSP components representing Ajax object pickers. Handles the JSF lifecycle for the Ajax component. The Ajax calls themselves are processed via the class org.alfresco.web.bean.ajax.PickerBean. The derived components are only responsible for specifing the ajax service call to make, plus any defaults for icons etc.

Author:

Kevin Roast

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`ACTION_CANCEL`
`protected static int`	`ACTION_DONE`
`protected Boolean`	`disabled` flag to show whether the component is disabled
`protected static String`	`EMPTY`
`protected static String`	`FOLDER_IMAGE_PREFIX`
`protected String`	`height` Height style override for picker selector area
`protected static String`	`ID_ICON`
`protected static String`	`ID_ID`
`protected static String`	`ID_NAME`
`protected String`	`initialSelectionId` id of the initially selected item, if value is not set
`protected String`	`label` label to be displayed before an item is selected
`protected static String`	`MSG_CANCEL`
`protected static String`	`MSG_GO_UP`
`protected static String`	`MSG_OK`
`protected Boolean`	`singleSelect` True for single select mode, false for multi-select mode

Fields inherited from class javax.faces.component.UIInput
COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID

Constructor Summary

Constructors
Constructor and Description

BaseAjaxItemPicker()

Constructors
Constructor and Description
`BaseAjaxItemPicker()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`decode(javax.faces.context.FacesContext context)`
`void`	`encodeBegin(javax.faces.context.FacesContext fc)`
`protected abstract String`	`getDefaultIcon()`
`abstract String`	`getFamily()`
`String`	`getHeight()`
`protected String`	`getHiddenFieldName()` We use a unique hidden field name based on our client Id.
`String`	`getInitialSelection()`
`protected String`	`getItemJson(String id, String name, String icon)` Returns Json string representing an already-selected item.
`String`	`getLabel()`
`protected String`	`getRequestAttributes()`
`protected abstract String`	`getServiceCall()`
`Boolean`	`getSingleSelect()`
`boolean`	`isDisabled()` Determines whether the component should be rendered in a disabled state
`void`	`restoreState(javax.faces.context.FacesContext context, Object state)`
`Object`	`saveState(javax.faces.context.FacesContext context)`
`void`	`setDisabled(boolean disabled)` Determines whether the component should be rendered in a disabled state
`void`	`setHeight(String height)`
`void`	`setInitialSelection(String initialSelection)`
`void`	`setLabel(String label)`
`void`	`setSingleSelect(Boolean singleSelect)`

Methods inherited from class javax.faces.component.UIInput
addValidator, addValueChangeListener, broadcast, compareValues, getConvertedValue, getSubmittedValue, getValidator, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, setImmediate, setLocalValueSet, setRequired, setSubmittedValue, setValid, setValidator, setValue, setValueChangeListener, updateModel, validate, validateValue

Methods inherited from class javax.faces.component.UIOutput
getConverter, getLocalValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

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

Methods inherited from interface javax.faces.component.ValueHolder
getConverter, getLocalValue, setConverter

- Field Detail
  - MSG_GO_UP
```
protected static final String MSG_GO_UP
```
    See Also:
    
    Constant Field Values
  - MSG_OK
```
protected static final String MSG_OK
```
    See Also:
    
    Constant Field Values
  - MSG_CANCEL
```
protected static final String MSG_CANCEL
```
    See Also:
    
    Constant Field Values
  - ID_ID
```
protected static final String ID_ID
```
    See Also:
    
    Constant Field Values
  - ID_NAME
```
protected static final String ID_NAME
```
    See Also:
    
    Constant Field Values
  - ID_ICON
```
protected static final String ID_ICON
```
    See Also:
    
    Constant Field Values
  - EMPTY
```
protected static final String EMPTY
```
    See Also:
    
    Constant Field Values
  - FOLDER_IMAGE_PREFIX
```
protected static final String FOLDER_IMAGE_PREFIX
```
    See Also:
    
    Constant Field Values
  - label
```
protected String label
```
    label to be displayed before an item is selected
  - initialSelectionId
```
protected String initialSelectionId
```
    id of the initially selected item, if value is not set
  - disabled
```
protected Boolean disabled
```
    flag to show whether the component is disabled
  - singleSelect
```
protected Boolean singleSelect
```
    True for single select mode, false for multi-select mode
  - height
```
protected String height
```
    Height style override for picker selector area
  - ACTION_DONE
```
protected static int ACTION_DONE
```
  - ACTION_CANCEL
```
protected static int ACTION_CANCEL
```
- Constructor Detail
  - BaseAjaxItemPicker
```
public BaseAjaxItemPicker()
```
- Method Detail
  - getFamily
```
public abstract String getFamily()
```
    Overrides:
    
    getFamily in class javax.faces.component.UIInput
    
    See Also:
    
    UIComponent.getFamily()
  - restoreState
```
public void restoreState(javax.faces.context.FacesContext context,
                         Object state)
```
    Specified by:
    
    restoreState in interface javax.faces.component.StateHolder
    
    Overrides:
    
    restoreState in class javax.faces.component.UIInput
    
    See Also:
    
    StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)
  - saveState
```
public Object saveState(javax.faces.context.FacesContext context)
```
    Specified by:
    
    saveState in interface javax.faces.component.StateHolder
    
    Overrides:
    
    saveState in class javax.faces.component.UIInput
    
    See Also:
    
    StateHolder.saveState(javax.faces.context.FacesContext)
  - decode
```
public void decode(javax.faces.context.FacesContext context)
```
    Overrides:
    
    decode in class javax.faces.component.UIInput
    
    See Also:
    
    UIComponentBase.decode(javax.faces.context.FacesContext)
  - encodeBegin
```
public void encodeBegin(javax.faces.context.FacesContext fc)
                 throws IOException
```
    Overrides:
    
    encodeBegin in class javax.faces.component.UIComponentBase
    
    Throws:
    
    IOException
    
    See Also:
    
    UIComponentBase.encodeBegin(javax.faces.context.FacesContext)
  - getServiceCall
```
protected abstract String getServiceCall()
```
    Returns:
    
    the ajax service bean call, for instance 'PickerBean.getFolderNodes'
  - getDefaultIcon
```
protected abstract String getDefaultIcon()
```
    Returns:
    
    default icon for the picker - if null then assume 'icon' property is always returned in service call results JSON objects.
  - getRequestAttributes
```
protected String getRequestAttributes()
```
    Returns:
    
    custom request properties optional for some specific picker implementations
  - getLabel
```
public String getLabel()
```
    Returns:
    
    Returns the label.
  - setLabel
```
public void setLabel(String label)
```
    Parameters:
    
    label - The label to set.
  - getInitialSelection
```
public String getInitialSelection()
```
    Returns:
    
    Returns the initial selection.
  - setInitialSelection
```
public void setInitialSelection(String initialSelection)
```
    Parameters:
    
    initialSelection - The initial selection to set.
  - isDisabled
```
public boolean isDisabled()
```
    Determines whether the component should be rendered in a disabled state
    
    Returns:
    
    Returns whether the component is disabled
  - setDisabled
```
public void setDisabled(boolean disabled)
```
    Determines whether the component should be rendered in a disabled state
    
    Parameters:
    
    disabled - true to disable the component
  - getSingleSelect
```
public Boolean getSingleSelect()
```
    Returns:
    
    true is single select mode, false for multi-select
  - setSingleSelect
```
public void setSingleSelect(Boolean singleSelect)
```
    Parameters:
    
    singleSelect - true for single select mode, false for multi-select
  - getHeight
```
public String getHeight()
```
    Returns:
    
    Returns the height.
  - setHeight
```
public void setHeight(String height)
```
    Parameters:
    
    height - The height to set.
  - getHiddenFieldName
```
protected String getHiddenFieldName()
```
    We use a unique hidden field name based on our client Id. This is on the assumption that there won't be many selectors on screen at once! Also means we have less values to decode on submit.
    
    Returns:
    
    hidden field name
  - getItemJson
```
protected String getItemJson(String id,
                             String name,
                             String icon)
```
    Returns Json string representing an already-selected item.
    
    Returns:
    
    hidden field name

Class BaseAjaxItemPicker

Field Summary

Fields inherited from class javax.faces.component.UIInput

Constructor Summary

Method Summary

Methods inherited from class javax.faces.component.UIInput

Methods inherited from class javax.faces.component.UIOutput

Methods inherited from class javax.faces.component.UIComponentBase

Methods inherited from class java.lang.Object

Methods inherited from interface javax.faces.component.ValueHolder

Field Detail

MSG_GO_UP

MSG_OK

MSG_CANCEL

ID_ID

ID_NAME

ID_ICON

EMPTY

FOLDER_IMAGE_PREFIX

label

initialSelectionId

disabled

singleSelect

height

ACTION_DONE

ACTION_CANCEL

Constructor Detail

BaseAjaxItemPicker

Method Detail

getFamily

restoreState

saveState

decode

encodeBegin

getServiceCall

getDefaultIcon

getRequestAttributes

getLabel

setLabel

getInitialSelection

setInitialSelection

isDisabled

setDisabled

getSingleSelect

setSingleSelect

getHeight

setHeight

getHiddenFieldName

getItemJson