org.deegree.client.core.component
Class HtmlOutputXML

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              org.deegree.client.core.component.HtmlOutputXML

All Implemented Interfaces:

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

public class HtmlOutputXML
extends javax.faces.component.UIOutput

Renders an XML document indented and colored, if possible. It's also possible to create a link for downloading the value. The created file will be deleted after the given time, default are 60 minutes.

Version:

$Revision: $, $Date: $

Author:

Lyn Buesching, last edited by: $Author: lyn $

Field Summary

Fields inherited from class javax.faces.component.UIOutput

COMPONENT_FAMILY, COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIComponent

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

Constructor Summary

HtmlOutputXML()

Method Summary

String	getDownloadFile()
String	getDownloadLabel()
int	getMinutesUntilDelete()
String	getStyleClass()
String	getValue()
boolean	isDownloadable()
void	setDownloadable(boolean downloadable)
void	setDownloadFile(String downloadFile)
void	setDownloadLabel(String downloadLabel)
void	setMinutesUntilDelete(int minutesUntilDelete)
void	setStyleClass(String styleClass)

Methods inherited from class javax.faces.component.UIOutput

clearInitialState, getConverter, getFamily, getLocalValue, markInitialState, restoreState, saveState, setConverter, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HtmlOutputXML

public HtmlOutputXML()

Method Detail

setDownloadLabel

public void setDownloadLabel(String downloadLabel)

Parameters:

downloadLabel - The text rendered as label for the download link. If null, the default value will be returned.

getDownloadLabel

public String getDownloadLabel()

Returns:

The text rendered as label for the download link.

setDownloadable

public void setDownloadable(boolean downloadable)

Parameters:

downloadable - true if a link for a download should be rendered. Default is false.

isDownloadable

public boolean isDownloadable()

Returns:

true, if a link for downloading the value as file should be rendered. Default is false.

setDownloadFile

public void setDownloadFile(String downloadFile)

Parameters:

downloadFile - The name of the directory in the web app directory, where the files should be stored. Can be null.

getDownloadFile

public String getDownloadFile()

Returns:

The name of the directory in the web app directory, where the files should be stored. Can be null.

setMinutesUntilDelete

public void setMinutesUntilDelete(int minutesUntilDelete)

Parameters:

minutesUntilDelete - Time in minutes after the created file should be deleted. A value <= 0 means, the file should not be deleted. Default value is 60.

getMinutesUntilDelete

public int getMinutesUntilDelete()

Returns:

The time in minutes after the created file should be deleted. A value <= 0 means, the file should not be deleted. Default value is 60.

getStyleClass

public String getStyleClass()

Returns:

A comma seperated list of available styleClasses. Default value is "outputXML".

setStyleClass

public void setStyleClass(String styleClass)

Parameters:

styleClass - A comma sepereated list of available style classes, passed through the class attribute of the component.

getValue

public String getValue()

Specified by:

getValue in interface javax.faces.component.ValueHolder

Overrides:

getValue in class javax.faces.component.UIOutput