javax.portlet.faces.component

Class PortletResourceURL

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.portlet.faces.component.PortletResourceURL

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

@ConsumerType
public class PortletResourceURL
extends javax.faces.component.UIComponentBase

Author:

Neil Griffin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	PortletResourceURL.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_FAMILY
static java.lang.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

Constructor Summary

Constructors

Constructor and Description
PortletResourceURL()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCacheability() cacheability attribute description:
java.lang.String	getFamily()
java.lang.String	getId() id attribute description:
java.lang.Boolean	getSecure() secure attribute description:
java.lang.String	getVar() var attribute description:
boolean	isEscapeXml() escapeXml attribute description:
void	setCacheability(java.lang.String cacheability) cacheability attribute description:
void	setEscapeXml(boolean escapeXml) escapeXml attribute description:
void	setId(java.lang.String id) id attribute description:
void	setSecure(java.lang.Boolean secure) secure attribute description:
void	setVar(java.lang.String var) var attribute description:

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, 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_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

PortletResourceURL

public PortletResourceURL()

Method Detail

getCacheability

public java.lang.String getCacheability()

cacheability attribute description:

The cacheability of the resource returned by the resourceURL. Valid values include ResourceURL.FULL, ResourceURL.PAGE, and ResourceURL.PORTLET. Defaults to ResourceURL.PAGE.

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getId

public java.lang.String getId()

id attribute description:

The id for the resource.

Overrides:

getId in class javax.faces.component.UIComponentBase

getSecure

public java.lang.Boolean getSecure()

secure attribute description:

When true, the URL will be secure. Defaults to the security setting of the current request.

getVar

public java.lang.String getVar()

var attribute description:

Introduces an EL variable that contains the URL.

isEscapeXml

public boolean isEscapeXml()

escapeXml attribute description:

When true, xml special characters will be escaped. Defaults to true.

setCacheability

public void setCacheability(java.lang.String cacheability)

cacheability attribute description:

The cacheability of the resource returned by the resourceURL. Valid values include ResourceURL.FULL, ResourceURL.PAGE, and ResourceURL.PORTLET. Defaults to ResourceURL.PAGE.

setEscapeXml

public void setEscapeXml(boolean escapeXml)

escapeXml attribute description:

When true, xml special characters will be escaped. Defaults to true.

setId

public void setId(java.lang.String id)

id attribute description:

The id for the resource.

Overrides:

setId in class javax.faces.component.UIComponentBase

setSecure

public void setSecure(java.lang.Boolean secure)

secure attribute description:

When true, the URL will be secure. Defaults to the security setting of the current request.

setVar

public void setVar(java.lang.String var)

var attribute description:

Introduces an EL variable that contains the URL.