org.nuxeo.ecm.platform.ui.web.component.document

Class RestDocumentLink

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIOutput

javax.faces.component.html.HtmlOutputLink

org.nuxeo.ecm.platform.ui.web.component.document.RestDocumentLink

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class RestDocumentLink
extends javax.faces.component.html.HtmlOutputLink

Component that gives generates a Restful link given a document.

Author:

Anahide Tchertchian

Nested Class Summary

Nested classes/interfaces inherited from class javax.faces.component.html.HtmlOutputLink

javax.faces.component.html.HtmlOutputLink.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	addTabInfo
protected String	baseURL
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	DEFAULT_VIEW_ID
protected DocumentModel	document
protected DocumentRef	documentIdRef
protected DocumentRef	documentPathRef
protected static com.sun.faces.renderkit.html_basic.HtmlBasicRenderer.Param[]	EMPTY_PARAMS
protected Boolean	newConversation
protected String	pattern
protected String	repositoryName
protected Boolean	resolveOnly
protected String	subTab
protected String	tab
protected String	tabs
protected String	var
protected String	view

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
RestDocumentLink()

Method Summary

Modifier and Type	Method and Description
protected void	afterRender(Object origVarValue) Restored the original value exposed as param to the request, and remove current variable value.
protected Object	beforeRender() Saves the current value exposed as param to the request, and put new variable value instead.
void	broadcast(javax.faces.event.FacesEvent event)
void	encodeBegin(javax.faces.context.FacesContext context)
void	encodeChildren(javax.faces.context.FacesContext context)
void	encodeEnd(javax.faces.context.FacesContext context)
Boolean	getAddTabInfo()
String	getBaseURL()
DocumentModel	getDocument()
DocumentRef	getDocumentIdRef()
DocumentRef	getDocumentPathRef()
String	getFamily()
Boolean	getNewConversation() Returns true if URL must link to a page in a new conversation.
protected com.sun.faces.renderkit.html_basic.HtmlBasicRenderer.Param[]	getParamList()
String	getPattern()
String	getRepositoryName()
Boolean	getResolveOnly()
String	getSubTab()
String	getTab()
String	getTabs()
Object	getValue() Override to build the URL thanks to other tag attributes information.
String	getVar()
String	getView()
boolean	invokeOnComponent(javax.faces.context.FacesContext context, String clientId, javax.faces.component.ContextCallback callback)
void	restoreState(javax.faces.context.FacesContext context, Object state)
Object	saveState(javax.faces.context.FacesContext context)
void	setAddTabInfo(Boolean addTabInfo)
void	setBaseURL(String baseURL)
void	setDocument(DocumentModel document)
void	setDocumentIdRef(DocumentRef documentIdRef)
void	setDocumentPathRef(DocumentRef documentPathRef)
void	setNewConversation(Boolean newConversation)
void	setPattern(String codec)
void	setRepositoryName(String repositoryName)
void	setResolveOnly(Boolean resolveOnly)
void	setSubTab(String subTab)
void	setTab(String tab)
void	setTabs(String tabs)
void	setVar(String var)
void	setView(String view)

Methods inherited from class javax.faces.component.html.HtmlOutputLink

getAccesskey, getCharset, getCoords, getDefaultEventName, getDir, getEventNames, getFragment, getHreflang, getLang, getOnblur, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getRel, getRev, getRole, getShape, getStyle, getStyleClass, getTabindex, getTarget, getTitle, getType, isDisabled, setAccesskey, setCharset, setCoords, setDir, setDisabled, setFragment, setHreflang, setLang, setOnblur, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setRel, setRev, setRole, setShape, setStyle, setStyleClass, setTabindex, setTarget, setTitle, setType

Methods inherited from class javax.faces.component.UIOutput

clearInitialState, getConverter, getLocalValue, markInitialState, resetValue, setConverter, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, decode, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

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.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

DEFAULT_VIEW_ID

public static final String DEFAULT_VIEW_ID

See Also:

Constant Field Values

EMPTY_PARAMS

protected static final com.sun.faces.renderkit.html_basic.HtmlBasicRenderer.Param[] EMPTY_PARAMS

document

protected DocumentModel document

repositoryName

protected String repositoryName

Since:

5.7

documentIdRef

protected DocumentRef documentIdRef

documentPathRef

protected DocumentRef documentPathRef

Since:

7.4

view

protected String view

tab

protected String tab

subTab

protected String subTab

tabs

protected String tabs

Since:

5.4.2

addTabInfo

protected Boolean addTabInfo

pattern

protected String pattern

newConversation

protected Boolean newConversation

baseURL

protected String baseURL

Since:

7.3

var

protected String var

Since:

5.7

resolveOnly

protected Boolean resolveOnly

Since:

5.7

Constructor Detail

RestDocumentLink

public RestDocumentLink()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIOutput

getValue

public Object getValue()

Override to build the URL thanks to other tag attributes information.

The document view service is queried to build it, and the tag attribute named "value" is ignored.

Specified by:

getValue in interface javax.faces.component.ValueHolder

Overrides:

getValue in class javax.faces.component.UIOutput

getParamList

protected com.sun.faces.renderkit.html_basic.HtmlBasicRenderer.Param[] getParamList()

getPattern

public String getPattern()

setPattern

public void setPattern(String codec)

getDocument

public DocumentModel getDocument()

setDocument

public void setDocument(DocumentModel document)

getRepositoryName

public String getRepositoryName()

setRepositoryName

public void setRepositoryName(String repositoryName)

getDocumentIdRef

public DocumentRef getDocumentIdRef()

setDocumentIdRef

public void setDocumentIdRef(DocumentRef documentIdRef)

getDocumentPathRef

public DocumentRef getDocumentPathRef()

setDocumentPathRef

public void setDocumentPathRef(DocumentRef documentPathRef)

getNewConversation

public Boolean getNewConversation()

Returns true if URL must link to a page in a new conversation.

Defaults to false.

setNewConversation

public void setNewConversation(Boolean newConversation)

getSubTab

public String getSubTab()

setSubTab

public void setSubTab(String subTab)

getTab

public String getTab()

setTab

public void setTab(String tab)

getBaseURL

public String getBaseURL()

Since:

7.3

setBaseURL

public void setBaseURL(String baseURL)

Since:

7.3

getView

public String getView()

setView

public void setView(String view)

getAddTabInfo

public Boolean getAddTabInfo()

setAddTabInfo

public void setAddTabInfo(Boolean addTabInfo)

getTabs

public String getTabs()

setTabs

public void setTabs(String tabs)

getResolveOnly

public Boolean getResolveOnly()

setResolveOnly

public void setResolveOnly(Boolean resolveOnly)

getVar

public String getVar()

setVar

public void setVar(String var)

beforeRender

protected Object beforeRender()

Saves the current value exposed as param to the request, and put new variable value instead.

Returns the original value exposed to the request.

Since:

5.7

afterRender

protected void afterRender(Object origVarValue)

Restored the original value exposed as param to the request, and remove current variable value.

Since:

5.7

invokeOnComponent

public boolean invokeOnComponent(javax.faces.context.FacesContext context,
                                 String clientId,
                                 javax.faces.component.ContextCallback callback)
                          throws javax.faces.FacesException

Overrides:

invokeOnComponent in class javax.faces.component.UIComponentBase

Throws:

javax.faces.FacesException

Since:

5.7

broadcast

public void broadcast(javax.faces.event.FacesEvent event)

Overrides:

broadcast in class javax.faces.component.UIComponentBase

Since:

5.7

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class javax.faces.component.UIComponentBase

Throws:

IOException

Since:

5.7

encodeChildren

public void encodeChildren(javax.faces.context.FacesContext context)
                    throws IOException

Overrides:

encodeChildren in class javax.faces.component.UIComponentBase

Throws:

IOException

encodeEnd

public void encodeEnd(javax.faces.context.FacesContext context)
               throws IOException

Overrides:

encodeEnd in class javax.faces.component.UIComponentBase

Throws:

IOException

Since:

5.7

saveState

public Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIOutput

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIOutput