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:

EventListener, javax.faces.component.NamingContainer, 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 UIOutputFile
extends javax.faces.component.UIOutput
implements javax.faces.component.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

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

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

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
UIOutputFile()

Method Summary

Modifier and Type	Method and Description
void	encodeBegin(javax.faces.context.FacesContext context)
void	encodeFileIcon(javax.faces.context.FacesContext context, Blob blob)
protected javax.el.ValueExpression	getBlobExpression(javax.faces.context.FacesContext context)
javax.el.MethodExpression	getConvertAction()
String	getDownloadLabel()
protected String	getDownloadLinkValue(javax.faces.context.FacesContext context, Blob blob, String filename)
javax.el.MethodExpression	getEditOnlineAction()
Boolean	getEditOnlineActionRendered()
String	getFilename()
protected javax.el.ValueExpression	getFileNameExpression(javax.faces.context.FacesContext context)
Boolean	getIconRendered()
Boolean	getQueryParent()
String	getRendererType()
String	getSeparator()
Object	getValue()
void	restoreState(javax.faces.context.FacesContext context, Object state)
Object	saveState(javax.faces.context.FacesContext context)
void	setConvertAction(javax.el.MethodExpression convertToPdfAction)
void	setDownloadLabel(String downloadLabel)
void	setEditOnlineAction(javax.el.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

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

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendersChildren, getValueBinding, invokeOnComponent, 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

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 javax.faces.component.UIComponentBase

getValue

public Object getValue()

Specified by:

getValue in interface javax.faces.component.ValueHolder

Overrides:

getValue in class javax.faces.component.UIOutput

getFilename

public String getFilename()

setFilename

public void setFilename(String filename)

getConvertAction

public javax.el.MethodExpression getConvertAction()

setConvertAction

public void setConvertAction(javax.el.MethodExpression convertToPdfAction)

getEditOnlineAction

public javax.el.MethodExpression getEditOnlineAction()

setEditOnlineAction

public void setEditOnlineAction(javax.el.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)

getBlobExpression

protected javax.el.ValueExpression getBlobExpression(javax.faces.context.FacesContext context)

getFileNameExpression

protected javax.el.ValueExpression getFileNameExpression(javax.faces.context.FacesContext context)

getDownloadLinkValue

protected String getDownloadLinkValue(javax.faces.context.FacesContext context,
                                      Blob blob,
                                      String filename)

encodeBegin

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

Overrides:

encodeBegin in class javax.faces.component.UIComponentBase

Throws:

IOException

encodeFileIcon

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

Throws:

IOException

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