org.alfresco.web.ui.common.component

Class UIGenericPicker

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:

javax.faces.component.ActionSource, javax.faces.component.StateHolder

public class UIGenericPicker
extends javax.faces.component.UICommand

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.

Field Summary

Fields inherited from class javax.faces.component.UICommand

COMPONENT_FAMILY, COMPONENT_TYPE

Constructor Summary

Constructors

Constructor and Description
UIGenericPicker() Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	broadcast(javax.faces.event.FacesEvent event)
void	decode(javax.faces.context.FacesContext context)
void	encodeBegin(javax.faces.context.FacesContext context)
java.lang.String	getAddButtonLabel()
java.lang.String	getFamily()
int	getFilterIndex()
javax.faces.model.SelectItem[]	getFilterOptions()
boolean	getFilterRefresh()
int	getHeight()
boolean	getMultiSelect()
javax.faces.el.MethodBinding	getQueryCallback()
java.lang.String	getSearchButtonLabel()
java.lang.String[]	getSelectedResults()
boolean	getShowAddButton()
boolean	getShowContains()
boolean	getShowFilter()
int	getWidth()
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setAddButtonLabel(java.lang.String addButtonLabel)
void	setFilterRefresh(boolean filterRefresh)
void	setHeight(int height)
void	setMultiSelect(boolean multiSelect)
void	setQueryCallback(javax.faces.el.MethodBinding binding)
void	setSearchButtonLabel(java.lang.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 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, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, 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

Constructor Detail

UIGenericPicker

public UIGenericPicker()

Default constructor

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UICommand

See Also:

UIComponent.getFamily()

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UICommand

See Also:

StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UICommand

See Also:

StateHolder.saveState(javax.faces.context.FacesContext)

decode

public void decode(javax.faces.context.FacesContext context)

Overrides:

decode in class javax.faces.component.UIComponentBase

See Also:

UIComponentBase.decode(javax.faces.context.FacesContext)

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class javax.faces.component.UICommand

Throws:

javax.faces.event.AbortProcessingException

See Also:

UIComponentBase.broadcast(javax.faces.event.FacesEvent)

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws java.io.IOException

Overrides:

encodeBegin in class javax.faces.component.UIComponentBase

Throws:

java.io.IOException

See Also:

UIComponentBase.encodeBegin(javax.faces.context.FacesContext)

getFilterOptions

public javax.faces.model.SelectItem[] getFilterOptions()

Returns:

the filter options

getFilterIndex

public int getFilterIndex()

Returns:

current filter drop-down selected index value

getSearchButtonLabel

public java.lang.String getSearchButtonLabel()

Returns:

Returns the searchButtonLabel.

setSearchButtonLabel

public void setSearchButtonLabel(java.lang.String searchButtonLabel)

Parameters:

searchButtonLabel - The searchButtonLabel to set.

getAddButtonLabel

public java.lang.String getAddButtonLabel()

Returns:

Returns the addButtonLabel.

setAddButtonLabel

public void setAddButtonLabel(java.lang.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 javax.faces.el.MethodBinding getQueryCallback()

Returns:

Returns the queryCallback.

setQueryCallback

public void setQueryCallback(javax.faces.el.MethodBinding binding)

Parameters:

binding - The queryCallback MethodBinding to set.

getSelectedResults

public java.lang.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.