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

Class UIPropertySheet

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIPanel

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

All Implemented Interfaces:

NamingContainer, StateHolder

public class UIPropertySheet
extends UIPanel
implements NamingContainer

Component that represents the properties of a Node

Author:

gavinc

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UIPropertySheet.ClientValidation Inner class representing a validation case that must be enforced.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EDIT_MODE
protected List<UIPropertySheet.ClientValidation>	validations
static String	VIEW_MODE

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
UIPropertySheet() Default constructor

Method Summary

Modifier and Type	Method and Description
void	addClientValidation(UIPropertySheet.ClientValidation validation) Adds a validation case to the property sheet
void	encodeBegin(FacesContext context)
void	encodeEnd(FacesContext context)
List<UIPropertySheet.ClientValidation>	getClientValidations()
String	getConfigArea()
String	getFamily()
String	getFinishButtonId() Returns the id of the finish button
String	getMode()
String	getNextButtonId() Returns the id of the next button
Node	getNode()
String	getVar()
boolean	inEditMode() Determines whether the property sheet is in edit mode
boolean	isReadOnly()
boolean	isValidationEnabled()
protected void	renderValidationMethod(ResponseWriter out, UIPropertySheet.ClientValidation validation, boolean lastMethod, boolean showMessage)
protected void	renderValidationScript(FacesContext context) Renders the necessary JavaScript to enforce any constraints the properties have.
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context)
void	setConfigArea(String configArea)
void	setFinishButtonId(String finishButtonId) Sets the id of the finish button being used on the page
void	setMode(String mode)
void	setNextButtonId(String nextButtonId) Sets the id of the next button being used on the page
void	setNode(Node node)
void	setReadOnly(boolean readOnly)
void	setValidationEnabled(boolean validationEnabled)
void	setVar(String variable)

Methods inherited from class javax.faces.component.UIComponentBase

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

VIEW_MODE

public static final String VIEW_MODE

See Also:

Constant Field Values

EDIT_MODE

public static final String EDIT_MODE

See Also:

Constant Field Values

validations

protected List<UIPropertySheet.ClientValidation> validations

Constructor Detail

UIPropertySheet

public UIPropertySheet()

Default constructor

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class UIPanel

See Also:

UIComponent.getFamily()

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class UIComponentBase

Throws:

IOException

See Also:

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

encodeEnd

public void encodeEnd(FacesContext context)
               throws IOException

Overrides:

encodeEnd in class UIComponentBase

Throws:

IOException

See Also:

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

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)

getNode

public Node getNode()

Returns:

Returns the node

setNode

public void setNode(Node node)

Parameters:

node - The node

getVar

public String getVar()

Returns:

Returns the variable.

setVar

public void setVar(String variable)

Parameters:

variable - The variable to set.

isReadOnly

public boolean isReadOnly()

Returns:

Returns whether the property sheet is read only

setReadOnly

public void setReadOnly(boolean readOnly)

Parameters:

readOnly - Sets the read only flag for the property sheet

isValidationEnabled

public boolean isValidationEnabled()

Returns:

true if validation is enabled for this property sheet

setValidationEnabled

public void setValidationEnabled(boolean validationEnabled)

Parameters:

validationEnabled - Sets the validationEnabled flag

getFinishButtonId

public String getFinishButtonId()

Returns the id of the finish button

Returns:

The id of the finish button on the page

setFinishButtonId

public void setFinishButtonId(String finishButtonId)

Sets the id of the finish button being used on the page

Parameters:

finishButtonId - The id of the finish button

getNextButtonId

public String getNextButtonId()

Returns the id of the next button

Returns:

The id of the next button on the page

setNextButtonId

public void setNextButtonId(String nextButtonId)

Sets the id of the next button being used on the page

Parameters:

nextButtonId - The id of the next button

getMode

public String getMode()

Returns:

Returns the mode

setMode

public void setMode(String mode)

Parameters:

mode - Sets the mode

inEditMode

public boolean inEditMode()

Determines whether the property sheet is in edit mode

Returns:

true if in edit mode

getConfigArea

public String getConfigArea()

Returns:

Returns the config area to use

setConfigArea

public void setConfigArea(String configArea)

Parameters:

configArea - Sets the config area to use

addClientValidation

public void addClientValidation(UIPropertySheet.ClientValidation validation)

Adds a validation case to the property sheet

Parameters:

validation - The validation case to enforce

getClientValidations

public List<UIPropertySheet.ClientValidation> getClientValidations()

Returns:

Returns the list of client validations to enforce

renderValidationScript

protected void renderValidationScript(FacesContext context)
                               throws IOException

Renders the necessary JavaScript to enforce any constraints the properties have.

Parameters:

context - FacesContext

Throws:

IOException

renderValidationMethod

protected void renderValidationMethod(ResponseWriter out,
                                      UIPropertySheet.ClientValidation validation,
                                      boolean lastMethod,
                                      boolean showMessage)
                               throws IOException

Throws:

IOException