javax.portlet.faces.component

Class PortletActionURL

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.portlet.faces.component.PortletActionURL

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

Author:

Neil Griffin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	PortletActionURL.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
PortletActionURL()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFamily()
java.lang.String	getName() name attribute description:
java.lang.String	getPortletMode() portletMode attribute description:
java.lang.Boolean	getSecure() secure attribute description:
java.lang.String	getVar() var attribute description:
java.lang.String	getWindowState() windowState attribute description:
boolean	isCopyCurrentRenderParameters() copyCurrentRenderParameters attribute description:
boolean	isEscapeXml() escapeXml attribute description:
void	setCopyCurrentRenderParameters(boolean copyCurrentRenderParameters) copyCurrentRenderParameters attribute description:
void	setEscapeXml(boolean escapeXml) escapeXml attribute description:
void	setName(java.lang.String name) name attribute description:
void	setPortletMode(java.lang.String portletMode) portletMode attribute description:
void	setSecure(java.lang.Boolean secure) secure attribute description:
void	setVar(java.lang.String var) var attribute description:
void	setWindowState(java.lang.String windowState) windowState 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, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, 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_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

PortletActionURL

public PortletActionURL()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getName

public java.lang.String getName()

name attribute description:

The name of the action method to be executed.

getPortletMode

public java.lang.String getPortletMode()

portletMode attribute description:

The name of the mode of the portlet which will be accessed via the URL.

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.

getWindowState

public java.lang.String getWindowState()

windowState attribute description:

The name of the window state of the portlet which will be accessed via the URL.

isCopyCurrentRenderParameters

public boolean isCopyCurrentRenderParameters()

copyCurrentRenderParameters attribute description:

When true, copy the current request's render parameters to the URL. Defaults to false.

isEscapeXml

public boolean isEscapeXml()

escapeXml attribute description:

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

setCopyCurrentRenderParameters

public void setCopyCurrentRenderParameters(boolean copyCurrentRenderParameters)

copyCurrentRenderParameters attribute description:

When true, copy the current request's render parameters to the URL. Defaults to false.

setEscapeXml

public void setEscapeXml(boolean escapeXml)

escapeXml attribute description:

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

setName

public void setName(java.lang.String name)

name attribute description:

The name of the action method to be executed.

setPortletMode

public void setPortletMode(java.lang.String portletMode)

portletMode attribute description:

The name of the mode of the portlet which will be accessed via the URL.

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.

setWindowState

public void setWindowState(java.lang.String windowState)

windowState attribute description:

The name of the window state of the portlet which will be accessed via the URL.