org.alfresco.web.ui.repo.component

Class UIContentSelector

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.UIContentSelector

All Implemented Interfaces:

EditableValueHolder, StateHolder, ValueHolder

public class UIContentSelector
extends UIInput

Component for selecting content from the repository

Author:

gavinc

Field Summary

Fields

Modifier and Type	Field and Description
protected List<org.alfresco.service.cmr.repository.NodeRef>	availableOptions List containing the currently available options
protected String	availableOptionsSize
protected Boolean	disabled

Fields inherited from class javax.faces.component.UIInput

COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID

Constructor Summary

Constructors

Constructor and Description
UIContentSelector() Default constructor

Method Summary

Modifier and Type	Method and Description
void	decode(FacesContext context)
void	encodeBegin(FacesContext context)
protected void	getAvailableOptions(FacesContext context, String contains) Retrieves the available options for the current association
String	getAvailableOptionsSize() Returns the size of the select control when multiple items can be selected
String	getFamily()
boolean	getMultiSelect()
boolean	isDisabled() Determines whether the component should be rendered in a disabled state
protected void	renderAvailableOptions(FacesContext context, ResponseWriter out, org.alfresco.service.cmr.repository.NodeService nodeService) Renders the list of available options
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context)
void	setAvailableOptionsSize(String availableOptionsSize) Sets the size of the select control used when multiple items can be selected
void	setDisabled(boolean disabled) Determines whether the component should be rendered in a disabled state
void	setMultiSelect(boolean multiSelect)

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

availableOptionsSize

protected String availableOptionsSize

disabled

protected Boolean disabled

availableOptions

protected List<org.alfresco.service.cmr.repository.NodeRef> availableOptions

List containing the currently available options

Constructor Detail

UIContentSelector

public UIContentSelector()

Default constructor

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class UIInput

See Also:

UIComponent.getFamily()

restoreState

public void restoreState(FacesContext context,
                         Object state)

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class UIInput

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 UIInput

See Also:

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

decode

public void decode(FacesContext context)

Overrides:

decode in class UIInput

See Also:

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

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class UIComponentBase

Throws:

IOException

See Also:

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

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

getAvailableOptionsSize

public String getAvailableOptionsSize()

Returns the size of the select control when multiple items can be selected

Returns:

The size of the select control

setAvailableOptionsSize

public void setAvailableOptionsSize(String availableOptionsSize)

Sets the size of the select control used when multiple items can be selected

Parameters:

availableOptionsSize - The size

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

renderAvailableOptions

protected void renderAvailableOptions(FacesContext context,
                                      ResponseWriter out,
                                      org.alfresco.service.cmr.repository.NodeService nodeService)
                               throws IOException

Renders the list of available options

Parameters:

context - FacesContext

out - Writer to write output to

nodeService - The NodeService

Throws:

IOException

getAvailableOptions

protected void getAvailableOptions(FacesContext context,
                                   String contains)

Retrieves the available options for the current association

Parameters:

context - Faces Context

contains - The contains part of the query