org.alfresco.web.ui.repo.component.property

Class BaseAssociationEditor

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.property.BaseAssociationEditor

All Implemented Interfaces:

EditableValueHolder, StateHolder, ValueHolder

Direct Known Subclasses:

UIAssociationEditor, UIChildAssociationEditor

public abstract class BaseAssociationEditor
extends UIInput

Base class for all association editor components

Author:

gavinc

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseAssociationEditor.AssocEditorEvent Class representing an action relevant to the AssociationEditor component.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	added
protected String	associationName
protected List<org.alfresco.service.cmr.repository.NodeRef>	availableOptions List containing the currently available options
protected String	availableOptionsSize
protected String	changingAssociation
protected Boolean	disabled
protected boolean	highlightedRow
protected String	noSelectedItemsMsg
protected Map<String,Object>	originalAssocs Map of the original associations keyed by the noderef of the child
protected Map<String,Object>	removed
protected String	searchTerm
protected String	selectedItemsMsg
protected String	selectItemMsg
protected String	selectItemsMsg
protected boolean	showAvailable

Fields inherited from class javax.faces.component.UIInput

COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID

Constructor Summary

Constructors

Constructor and Description
BaseAssociationEditor() Default constructor

Method Summary

Modifier and Type	Method and Description
protected abstract void	addTarget(Node node, String[] toAdd) Updates the component and node state to reflect an association being added
void	broadcast(FacesEvent event)
void	decode(FacesContext context)
void	encodeBegin(FacesContext context)
protected String	generateFormSubmit(FacesContext context, String action) Generate FORM submit JavaScript for the specified action
protected org.alfresco.service.cmr.dictionary.AssociationDefinition	getAssociationDefinition(FacesContext context) Retrieves the AssociationDefinition for the association we are representing
String	getAssociationName() Returns the name of the association this component is editing
protected void	getAvailableOptions(FacesContext context, String contains) Retrieves the available options for the current association
String	getAvailableOptionsSize() Returns the size of the select control
protected String	getHiddenFieldName() We use a hidden field per picker instance on the page.
String	getNoSelectedItemsMsg() Returns the message to display when no items have been selected, if one hasn't been set it defaults to the message in the bundle under key 'no_selected_items'.
String	getSelectedItemsMsg() Returns the message to display for the selected items, if one hasn't been set it defaults to the message in the bundle under key 'selected_items'.
String	getSelectItemMsg() Returns the message to display for select an item, if one hasn't been set it defaults to the message in the bundle under key 'search_select_item'.
String	getSelectItemsMsg() Returns the message to display for select items, if one hasn't been set it defaults to the message in the bundle under key 'search_select_items'.
boolean	isDisabled() Determines whether the component should be rendered in a disabled state
protected abstract void	populateAssocationMaps(Node node, org.alfresco.service.cmr.repository.NodeService nodeService) Populates all the internal Maps with the appropriate association reference objects
protected abstract void	removeTarget(Node node, String targetRef) Updates the component and node state to reflect an association being removed
protected void	renderAvailableOptions(FacesContext context, ResponseWriter out, org.alfresco.service.cmr.repository.NodeService nodeService, String targetType, boolean allowMany) Renders the list of available options for a new association
protected void	renderExistingAssociation(FacesContext context, ResponseWriter out, org.alfresco.service.cmr.repository.NodeService nodeService, org.alfresco.service.cmr.repository.NodeRef targetRef, boolean allowMany) Renders an existing association with the appropriate options
protected abstract void	renderExistingAssociations(FacesContext context, ResponseWriter out, org.alfresco.service.cmr.repository.NodeService nodeService, boolean allowMany) Renders the existing associations in an editable form
protected void	renderNone(FacesContext context, ResponseWriter out) Renders the message
protected abstract void	renderReadOnlyAssociations(FacesContext context, ResponseWriter out, org.alfresco.service.cmr.repository.NodeService nodeService) Renders the existing associations in a read-only form
protected void	renderSearchField(FacesContext context, ResponseWriter out) Renders the search fields
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context)
void	setAssociationName(String associationName) Sets the name of the association this component will edit
void	setAvailableOptionsSize(String availableOptionsSize) Sets the size of the select control
void	setDisabled(boolean disabled) Determines whether the component should be rendered in a disabled state
void	setNoSelectedItemsMsg(String noSelectedItemsMsg) Sets the no selected items message to display in the UI
void	setSelectedItemsMsg(String selectedItemsMsg) Sets the selected items message to display in the UI
void	setSelectItemMsg(String selectItemMsg) Sets the select an item message to display in the UI
void	setSelectItemsMsg(String selectItemsMsg) Sets the select items message to display in the UI

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, compareValues, getConvertedValue, getFamily, 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

associationName

protected String associationName

availableOptionsSize

protected String availableOptionsSize

selectItemMsg

protected String selectItemMsg

selectItemsMsg

protected String selectItemsMsg

selectedItemsMsg

protected String selectedItemsMsg

noSelectedItemsMsg

protected String noSelectedItemsMsg

searchTerm

protected String searchTerm

disabled

protected Boolean disabled

showAvailable

protected boolean showAvailable

originalAssocs

protected Map<String,Object> originalAssocs

Map of the original associations keyed by the noderef of the child

added

protected Map<String,Object> added

removed

protected Map<String,Object> removed

availableOptions

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

List containing the currently available options

changingAssociation

protected String changingAssociation

highlightedRow

protected boolean highlightedRow

Constructor Detail

BaseAssociationEditor

public BaseAssociationEditor()

Default constructor

Method Detail

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)

broadcast

public void broadcast(FacesEvent event)
               throws AbortProcessingException

Overrides:

broadcast in class UIInput

Throws:

AbortProcessingException

See Also:

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

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class UIComponentBase

Throws:

IOException

See Also:

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

getAssociationName

public String getAssociationName()

Returns the name of the association this component is editing

Returns:

Association name

setAssociationName

public void setAssociationName(String associationName)

Sets the name of the association this component will edit

Parameters:

associationName - Name of the association to edit

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

Returns:

The size of the select control

setAvailableOptionsSize

public void setAvailableOptionsSize(String availableOptionsSize)

Sets the size of the select control

Parameters:

availableOptionsSize - The size

getNoSelectedItemsMsg

public String getNoSelectedItemsMsg()

Returns the message to display when no items have been selected, if one hasn't been set it defaults to the message in the bundle under key 'no_selected_items'.

Returns:

The message

setNoSelectedItemsMsg

public void setNoSelectedItemsMsg(String noSelectedItemsMsg)

Sets the no selected items message to display in the UI

Parameters:

noSelectedItemsMsg - The message

getSelectedItemsMsg

public String getSelectedItemsMsg()

Returns the message to display for the selected items, if one hasn't been set it defaults to the message in the bundle under key 'selected_items'.

Returns:

The message

setSelectedItemsMsg

public void setSelectedItemsMsg(String selectedItemsMsg)

Sets the selected items message to display in the UI

Parameters:

selectedItemsMsg - The message

getSelectItemMsg

public String getSelectItemMsg()

Returns the message to display for select an item, if one hasn't been set it defaults to the message in the bundle under key 'search_select_item'.

Returns:

The message

setSelectItemMsg

public void setSelectItemMsg(String selectItemMsg)

Sets the select an item message to display in the UI

Parameters:

selectItemMsg - The message

getSelectItemsMsg

public String getSelectItemsMsg()

Returns the message to display for select items, if one hasn't been set it defaults to the message in the bundle under key 'search_select_items'.

Returns:

The message

setSelectItemsMsg

public void setSelectItemsMsg(String selectItemsMsg)

Sets the select items message to display in the UI

Parameters:

selectItemsMsg - The message

populateAssocationMaps

protected abstract void populateAssocationMaps(Node node,
                                               org.alfresco.service.cmr.repository.NodeService nodeService)

Populates all the internal Maps with the appropriate association reference objects

Parameters:

node - The Node we are dealing with

nodeService - The NodeService

renderReadOnlyAssociations

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

Renders the existing associations in a read-only form

Parameters:

context - FacesContext

out - ResponseWriter

nodeService - The NodeService

Throws:

IOException

renderExistingAssociations

protected abstract void renderExistingAssociations(FacesContext context,
                                                   ResponseWriter out,
                                                   org.alfresco.service.cmr.repository.NodeService nodeService,
                                                   boolean allowMany)
                                            throws IOException

Renders the existing associations in an editable form

Parameters:

context - FacesContext

out - ResponseWriter

nodeService - The NodeService

allowMany - Whether multiple associations are allowed

Throws:

IOException

removeTarget

protected abstract void removeTarget(Node node,
                                     String targetRef)

Updates the component and node state to reflect an association being removed

Parameters:

node - The node we are dealing with

targetRef - The noderef of the child to remove

addTarget

protected abstract void addTarget(Node node,
                                  String[] toAdd)

Updates the component and node state to reflect an association being added

Parameters:

node - The node we are dealing with

toAdd - The noderefs of the children to add

renderExistingAssociation

protected void renderExistingAssociation(FacesContext context,
                                         ResponseWriter out,
                                         org.alfresco.service.cmr.repository.NodeService nodeService,
                                         org.alfresco.service.cmr.repository.NodeRef targetRef,
                                         boolean allowMany)
                                  throws IOException

Renders an existing association with the appropriate options

Parameters:

context - FacesContext

out - Writer to write output to

nodeService - The NodeService

targetRef - The node at the end of the association being rendered

allowMany - Whether the current association allows multiple children

Throws:

IOException

renderSearchField

protected void renderSearchField(FacesContext context,
                                 ResponseWriter out)
                          throws IOException

Renders the search fields

Parameters:

context - Faces Context

out - The Response Writer

Throws:

IOException

renderNone

protected void renderNone(FacesContext context,
                          ResponseWriter out)
                   throws IOException

Renders the message

Parameters:

context - Faces Context

out - Response Writer

Throws:

IOException

renderAvailableOptions

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

Renders the list of available options for a new association

Parameters:

context - FacesContext

out - Writer to write output to

nodeService - The NodeService

targetType - The type of the child at the end of the association

allowMany - Whether the current association allows multiple children

Throws:

IOException

getAssociationDefinition

protected org.alfresco.service.cmr.dictionary.AssociationDefinition getAssociationDefinition(FacesContext context)

Retrieves the AssociationDefinition for the association we are representing

Parameters:

context - Faces Context

Returns:

The AssociationDefinition for the association, null if a definition does not exist

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

getHiddenFieldName

protected String getHiddenFieldName()

We use a hidden field per picker instance on the page.

Returns:

hidden field name

generateFormSubmit

protected String generateFormSubmit(FacesContext context,
                                    String action)

Generate FORM submit JavaScript for the specified action

Parameters:

context - FacesContext

action - Action string

Returns:

FORM submit JavaScript