org.alfresco.web.ui.repo.component

Class UILockIcon

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent

org.alfresco.web.ui.repo.component.UILockIcon

All Implemented Interfaces:

StateHolder

public class UILockIcon
extends org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent

Author:

Kevin Roast

Constructor Summary

Constructors

Constructor and Description
UILockIcon()

Method Summary

Modifier and Type	Method and Description
void	encodeBegin(FacesContext context)
protected void	encodeBegin(FacesContext context, boolean locked, boolean lockedOwner, String[] lockUser)
String	getAlign()
String	getFamily()
int	getHeight()
String	getLockedOwnerTooltip()
String	getLockedUserTooltip()
String	getLockImage()
String	getLockOwnerImage()
Object	getValue()
int	getWidth()
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context)
void	setAlign(String align)
void	setHeight(int height)
void	setLockedOwnerTooltip(String lockedOwnerTooltip)
void	setLockedUserTooltip(String lockedUserTooltip)
void	setLockImage(String lockImage)
void	setLockOwnerImage(String lockOwnerImage)
void	setValue(Object value)
void	setWidth(int width)

Methods inherited from class org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent

outputAttribute

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

Constructor Detail

UILockIcon

public UILockIcon()

Method Detail

getFamily

public String getFamily()

Specified by:

getFamily in class UIComponent

See Also:

UIComponent.getFamily()

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)

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class UIComponentBase

Throws:

IOException

See Also:

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

encodeBegin

protected void encodeBegin(FacesContext context,
                           boolean locked,
                           boolean lockedOwner,
                           String[] lockUser)
                    throws IOException

Throws:

IOException

getLockImage

public String getLockImage()

Returns:

the image to display as the lock icon. A default is provided if none is set.

setLockImage

public void setLockImage(String lockImage)

Parameters:

lockImage - the image to display as the lock icon. A default is provided if none is set.

getLockOwnerImage

public String getLockOwnerImage()

Returns:

Returns the image to display if the owner has the lock.

setLockOwnerImage

public void setLockOwnerImage(String lockOwnerImage)

Parameters:

lockOwnerImage - the image to display if the owner has the lock.

getAlign

public String getAlign()

Returns:

Returns the image alignment value.

setAlign

public void setAlign(String align)

Parameters:

align - The image alignment value to set.

getHeight

public int getHeight()

Returns:

Returns the icon height.

setHeight

public void setHeight(int height)

Parameters:

height - The icon height to set.

getWidth

public int getWidth()

Returns:

Returns the icon width.

setWidth

public void setWidth(int width)

Parameters:

width - The iconwidth to set.

getLockedOwnerTooltip

public String getLockedOwnerTooltip()

Returns:

Returns the lockedOwnerTooltip.

setLockedOwnerTooltip

public void setLockedOwnerTooltip(String lockedOwnerTooltip)

Parameters:

lockedOwnerTooltip - The lockedOwnerTooltip to set.

getLockedUserTooltip

public String getLockedUserTooltip()

Returns:

Returns the lockedUserTooltip.

setLockedUserTooltip

public void setLockedUserTooltip(String lockedUserTooltip)

Parameters:

lockedUserTooltip - The lockedUserTooltip to set.

getValue

public Object getValue()

Returns:

Returns the value (Node or NodeRef)

setValue

public void setValue(Object value)

Parameters:

value - The Node or NodeRef value to set.