Nuxeo Enterprise Platform 5.4

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

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by javax.faces.component.html.HtmlOutputLink
                  extended by org.nuxeo.ecm.platform.ui.web.component.document.RestDocumentLink
All Implemented Interfaces:
javax.faces.component.StateHolder, javax.faces.component.ValueHolder

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

Component that gives generates a Restful link given a document.

Author:
Anahide Tchertchian

Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String DEFAULT_VIEW_ID
           
 
Fields inherited from class javax.faces.component.html.HtmlOutputLink
COMPONENT_TYPE
 
Constructor Summary
RestDocumentLink()
           
 
Method Summary
 DocumentModel getDocument()
           
 DocumentRef getDocumentIdRef()
           
 java.lang.Boolean getNewConversation()
          Returns true if URL must link to a page in a new conversation.
 java.lang.String getPattern()
           
 java.lang.String getSubTab()
           
 java.lang.String getTab()
           
 java.lang.Object getValue()
          Override to build the URL thanks to other tag attributes information.
 java.lang.String getView()
           
 void setDocument(DocumentModel document)
           
 void setDocumentIdRef(DocumentRef documentIdRef)
           
 void setNewConversation(java.lang.Boolean newConversation)
           
 void setPattern(java.lang.String codec)
           
 void setSubTab(java.lang.String subTab)
           
 void setTab(java.lang.String tab)
           
 void setView(java.lang.String view)
           
 
Methods inherited from class javax.faces.component.html.HtmlOutputLink
getAccesskey, getCharset, getCoords, getDir, getHreflang, getLang, getOnblur, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getRel, getRev, getShape, getStyle, getStyleClass, getTabindex, getTarget, getTitle, getType, isDisabled, restoreState, saveState, setAccesskey, setCharset, setCoords, setDir, setDisabled, setHreflang, setLang, setOnblur, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setRel, setRev, setShape, setStyle, setStyleClass, setTabindex, setTarget, setTitle, setType
 
Methods inherited from class javax.faces.component.UIOutput
getConverter, getFamily, getLocalValue, setConverter, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId, getValueExpression, setValueExpression
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

DEFAULT_VIEW_ID

public static final java.lang.String DEFAULT_VIEW_ID
See Also:
Constant Field Values
Constructor Detail

RestDocumentLink

public RestDocumentLink()
Method Detail

getValue

public java.lang.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

getPattern

public java.lang.String getPattern()

setPattern

public void setPattern(java.lang.String codec)

getDocument

public DocumentModel getDocument()

setDocument

public void setDocument(DocumentModel document)

getDocumentIdRef

public DocumentRef getDocumentIdRef()

setDocumentIdRef

public void setDocumentIdRef(DocumentRef documentIdRef)

getNewConversation

public java.lang.Boolean getNewConversation()
Returns true if URL must link to a page in a new conversation.

Defaults to false.


setNewConversation

public void setNewConversation(java.lang.Boolean newConversation)

getSubTab

public java.lang.String getSubTab()

setSubTab

public void setSubTab(java.lang.String subTab)

getTab

public java.lang.String getTab()

setTab

public void setTab(java.lang.String tab)

getView

public java.lang.String getView()

setView

public void setView(java.lang.String view)

Nuxeo Enterprise Platform 5.4

Copyright © 2010 Nuxeo SAS. All Rights Reserved.