com.liferay.faces.portlet.component.portleturl

Class PortletURLBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

com.liferay.faces.portlet.component.baseurl.BaseURLBase

com.liferay.faces.portlet.component.baseurl.BaseURL

com.liferay.faces.portlet.component.portleturl.PortletURLBase

All Implemented Interfaces:

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

Direct Known Subclasses:

ActionURLBase, PortletURL

@Generated(value="com.liferay.alloy.tools.builder.FacesBuilder")
public abstract class PortletURLBase
extends BaseURL

Author:

Neil Griffin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	PortletURLBase.PortletURLPropertyKeys

Nested classes/interfaces inherited from class com.liferay.faces.portlet.component.baseurl.BaseURLBase

BaseURLBase.BaseURLPropertyKeys

Field Summary

Fields

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

Fields inherited from class com.liferay.faces.portlet.component.baseurl.BaseURLBase

COMPONENT_FAMILY

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
PortletURLBase()

Method Summary

Methods

Modifier and Type	Method and Description
String	getPortletMode() portletMode attribute description: The name of the mode of the portlet which will be accessed via the URL.
String	getWindowState() windowState attribute description: The name of the window state of the portlet which will be accessed via the URL.
boolean	isCopyCurrentRenderParameters() copyCurrentRenderParameters attribute description: When true, copy the current request's render parameters to the URL.
void	setCopyCurrentRenderParameters(boolean copyCurrentRenderParameters) copyCurrentRenderParameters attribute description: When true, copy the current request's render parameters to the URL.
void	setPortletMode(String portletMode) portletMode attribute description: The name of the mode of the portlet which will be accessed via the URL.
void	setWindowState(String windowState) windowState attribute description: The name of the window state of the portlet which will be accessed via the URL.

Methods inherited from class com.liferay.faces.portlet.component.baseurl.BaseURLBase

getFamily, getSecure, getVar, isEscapeXml, setEscapeXml, setSecure, setVar

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_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

PortletURLBase

public PortletURLBase()

Method Detail

isCopyCurrentRenderParameters

public boolean isCopyCurrentRenderParameters()

copyCurrentRenderParameters attribute description:

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

setCopyCurrentRenderParameters

public void setCopyCurrentRenderParameters(boolean copyCurrentRenderParameters)

copyCurrentRenderParameters attribute description:

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

getPortletMode

public String getPortletMode()

portletMode attribute description:

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

setPortletMode

public void setPortletMode(String portletMode)

portletMode attribute description:

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

getWindowState

public String getWindowState()

windowState attribute description:

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

setWindowState

public void setWindowState(String windowState)

windowState attribute description:

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