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

Class PropertySheetItem

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIPanel

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

All Implemented Interfaces:

NamingContainer, StateHolder

Direct Known Subclasses:

UIAssociation, UIChildAssociation, UIProperty, UISeparator

public abstract class PropertySheetItem
extends UIPanel
implements NamingContainer

Abstract base class for all items that can appear in a property sheet component

Author:

gavinc

Field Summary

Fields

Modifier and Type	Field and Description
protected String	componentGenerator
protected String	converter
protected String	displayLabel
protected Boolean	ignoreIfMissing
protected String	name
protected Boolean	readOnly
protected String	resolvedDisplayLabel

Fields inherited from class javax.faces.component.UIPanel

COMPONENT_FAMILY, COMPONENT_TYPE

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
PropertySheetItem()

Method Summary

Modifier and Type	Method and Description
void	encodeBegin(FacesContext context)
protected abstract void	generateItem(FacesContext context, UIPropertySheet propSheet) Generates the label and control for the item
protected void	generateLabel(FacesContext context, UIPropertySheet propSheet, String displayLabel) Generates a JSF OutputText component/renderer
String	getComponentGenerator()
String	getConverter()
String	getDisplayLabel()
boolean	getIgnoreIfMissing()
protected abstract String	getIncorrectParentMsg() Returns the message to use in the exception that is thrown if the component is not nested inside a PropertySheet component
String	getName()
String	getResolvedDisplayLabel() Returns the resolved display label
boolean	isReadOnly()
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context)
void	setComponentGenerator(String componentGenerator)
void	setConverter(String converter)
void	setDisplayLabel(String displayLabel)
void	setIgnoreIfMissing(boolean ignoreIfMissing)
void	setName(String name)
void	setReadOnly(boolean readOnly)

Methods inherited from class javax.faces.component.UIPanel

getFamily

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, 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, 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

Field Detail

name

protected String name

displayLabel

protected String displayLabel

converter

protected String converter

readOnly

protected Boolean readOnly

ignoreIfMissing

protected Boolean ignoreIfMissing

componentGenerator

protected String componentGenerator

resolvedDisplayLabel

protected String resolvedDisplayLabel

Constructor Detail

PropertySheetItem

public PropertySheetItem()

Method Detail

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class UIComponentBase

Throws:

IOException

See Also:

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

getDisplayLabel

public String getDisplayLabel()

Returns:

Returns the display label

setDisplayLabel

public void setDisplayLabel(String displayLabel)

Parameters:

displayLabel - Sets the display label

getName

public String getName()

Returns:

Returns the name

setName

public void setName(String name)

Parameters:

name - Sets the name

getConverter

public String getConverter()

Returns:

Returns the converter

setComponentGenerator

public void setComponentGenerator(String componentGenerator)

Parameters:

componentGenerator - Sets the component generator

getComponentGenerator

public String getComponentGenerator()

Returns:

Returns the component generator

setConverter

public void setConverter(String converter)

Parameters:

converter - Sets the converter

isReadOnly

public boolean isReadOnly()

Returns:

Returns whether the property is read only

setReadOnly

public void setReadOnly(boolean readOnly)

Parameters:

readOnly - Sets the read only flag for the component

getIgnoreIfMissing

public boolean getIgnoreIfMissing()

Returns:

Determines whether the item should be ignored (not rendered) if the item can not be found

setIgnoreIfMissing

public void setIgnoreIfMissing(boolean ignoreIfMissing)

Parameters:

ignoreIfMissing - Sets the whether the item will be ignored if it can not be found

restoreState

public void restoreState(FacesContext context,
                         Object state)

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class UIComponentBase

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 UIComponentBase

See Also:

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

getResolvedDisplayLabel

public String getResolvedDisplayLabel()

Returns the resolved display label

Returns:

The display label being used at runtime

generateItem

protected abstract void generateItem(FacesContext context,
                                     UIPropertySheet propSheet)
                              throws IOException

Generates the label and control for the item

Parameters:

context - FacesContext

propSheet - The property sheet that the item is a child of

Throws:

IOException

getIncorrectParentMsg

protected abstract String getIncorrectParentMsg()

Returns the message to use in the exception that is thrown if the component is not nested inside a PropertySheet component

Returns:

The message

generateLabel

protected void generateLabel(FacesContext context,
                             UIPropertySheet propSheet,
                             String displayLabel)

Generates a JSF OutputText component/renderer

Parameters:

context - JSF context

propSheet - The property sheet that the item is a child of

displayLabel - The display label text