com.liferay.faces.portlet.component.baseurl

Class BaseURLBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

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

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:

BaseURL

@Generated(value="com.liferay.alloy.tools.builder.FacesBuilder")
public abstract class BaseURLBase
extends javax.faces.component.UIComponentBase

Author:

Neil Griffin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	BaseURLBase.BaseURLPropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	RENDERER_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
BaseURLBase()

Method Summary

Methods

Modifier and Type	Method and Description
String	getFamily()
Boolean	getSecure() secure attribute description: When true, the URL will be secure.
String	getVar() var attribute description: Introduces an EL variable that contains the URL.
boolean	isEscapeXml() escapeXml attribute description: When true, xml special characters will be escaped.
void	setEscapeXml(boolean escapeXml) escapeXml attribute description: When true, xml special characters will be escaped.
void	setSecure(Boolean secure) secure attribute description: When true, the URL will be secure.
void	setVar(String var) var attribute description: Introduces an EL variable that contains the URL.

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 String COMPONENT_FAMILY

See Also:

Constant Field Values

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

BaseURLBase

public BaseURLBase()

Method Detail

getFamily

public String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

isEscapeXml

public boolean isEscapeXml()

escapeXml attribute description:

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

setEscapeXml

public void setEscapeXml(boolean escapeXml)

escapeXml attribute description:

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

getSecure

public Boolean getSecure()

secure attribute description:

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

setSecure

public void setSecure(Boolean secure)

secure attribute description:

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

getVar

public String getVar()

var attribute description:

Introduces an EL variable that contains the URL.

setVar

public void setVar(String var)

var attribute description:

Introduces an EL variable that contains the URL.