org.nuxeo.ecm.platform.ui.web.component.file
Class UIOutputFile

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              org.nuxeo.ecm.platform.ui.web.component.file.UIOutputFile

All Implemented Interfaces:

NamingContainer, StateHolder, ValueHolder

public class UIOutputFile
extends UIOutput
implements NamingContainer

UIOutput file.

Attribute named value is the file to be displayed. Its submitted value as well as filename are handled by sub components in facets. Rendering is handled here.

If convertAction and editOnlineAction method bindings are set, corresponding links are rendered. The editOnlineActionRendered is used to filter action visibility.

Author:

Anahide Tchertchian

Field Summary

static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

UIOutputFile()

Method Summary

void	encodeBegin(FacesContext context)
void	encodeFileIcon(FacesContext context, Blob blob)
MethodExpression	getConvertAction()
String	getDownloadLabel()
MethodExpression	getEditOnlineAction()
Boolean	getEditOnlineActionRendered()
String	getFilename()
Boolean	getIconRendered()
Boolean	getQueryParent()
String	getRendererType()
String	getSeparator()
Object	getValue()
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context)
void	setConvertAction(MethodExpression convertToPdfAction)
void	setDownloadLabel(String downloadLabel)
void	setEditOnlineAction(MethodExpression editOnlineAction)
void	setEditOnlineActionRendered(Boolean editOnlineActionRendered)
void	setFilename(String filename)
void	setIconRendered(Boolean iconRendered)
void	setQueryParent(Boolean queryParent)
void	setSeparator(String actionsSeparator)

Methods inherited from class javax.faces.component.UIOutput

getConverter, getFamily, getLocalValue, setConverter, setValue

Methods inherited from class javax.faces.component.UIComponentBase

broadcast, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, 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_TYPE

public static final String COMPONENT_TYPE

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

UIOutputFile

public UIOutputFile()

Method Detail

getRendererType

public String getRendererType()

Overrides:

getRendererType in class UIComponentBase

getValue

public Object getValue()

Specified by:

getValue in interface ValueHolder

Overrides:

getValue in class UIOutput

getFilename

public String getFilename()

setFilename

public void setFilename(String filename)

getConvertAction

public MethodExpression getConvertAction()

setConvertAction

public void setConvertAction(MethodExpression convertToPdfAction)

getEditOnlineAction

public MethodExpression getEditOnlineAction()

setEditOnlineAction

public void setEditOnlineAction(MethodExpression editOnlineAction)

getEditOnlineActionRendered

public Boolean getEditOnlineActionRendered()

setEditOnlineActionRendered

public void setEditOnlineActionRendered(Boolean editOnlineActionRendered)

getSeparator

public String getSeparator()

getQueryParent

public Boolean getQueryParent()

setQueryParent

public void setQueryParent(Boolean queryParent)

setSeparator

public void setSeparator(String actionsSeparator)

getDownloadLabel

public String getDownloadLabel()

setDownloadLabel

public void setDownloadLabel(String downloadLabel)

getIconRendered

public Boolean getIconRendered()

setIconRendered

public void setIconRendered(Boolean iconRendered)

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class UIComponentBase

Throws:

IOException

encodeFileIcon

public void encodeFileIcon(FacesContext context,
                           Blob blob)
                    throws IOException

Throws:

IOException

saveState

public Object saveState(FacesContext context)

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class UIOutput

restoreState

public void restoreState(FacesContext context,
                         Object state)

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class UIOutput