Skip navigation links
A B C D E F G H I J L M N P R S T U V W 

A

ActionURL - Class in com.liferay.faces.portlet.component.actionurl
 
ActionURL() - Constructor for class com.liferay.faces.portlet.component.actionurl.ActionURL
 
ActionURLBase - Class in com.liferay.faces.portlet.component.actionurl
 
ActionURLBase() - Constructor for class com.liferay.faces.portlet.component.actionurl.ActionURLBase
 
ActionURLBase.ActionURLPropertyKeys - Enum in com.liferay.faces.portlet.component.actionurl
 
ADD_ELEMENT_TO_HEAD_SUPPORT - Static variable in class com.liferay.faces.bridge.context.BridgePortalContext
Property indicating if the portal application supports adding elements to the <head>...</head> section of the rendered portal page.
ADD_SCRIPT_RESOURCE_TO_HEAD_SUPPORT - Static variable in class com.liferay.faces.bridge.context.BridgePortalContext
Property indicating if the portal application supports adding a <script src=".." /> resource to the <head>...</head> section of the rendered portal page.
ADD_SCRIPT_TEXT_TO_HEAD_SUPPORT - Static variable in class com.liferay.faces.bridge.context.BridgePortalContext
Property indicating if the portal application supports adding <script> text to the <head>...</head> section of the rendered portal page.
ADD_STYLE_SHEET_RESOURCE_TO_HEAD_SUPPORT - Static variable in class com.liferay.faces.bridge.context.BridgePortalContext
Property indicating if the portal application supports adding stylesheet <link> tags to the <head>...</head> section of the rendered portal page.
ADD_STYLE_SHEET_TEXT_TO_HEAD_SUPPORT - Static variable in class com.liferay.faces.bridge.context.BridgePortalContext
Property indicating if the portal application supports adding <style> text to the <head>...</head> section of the rendered portal page.

B

BACK_LINK - Static variable in interface javax.portlet.faces.Bridge
Special token parameter in the URL passed to the bridge's implementation of ExternalContext.encodeResourceURL(String) that it recognizes as an indication that an URL referring back to the page which contains this portlet should be encoded in the resource URL.
BaseURL - Class in com.liferay.faces.portlet.component.baseurl
 
BaseURL() - Constructor for class com.liferay.faces.portlet.component.baseurl.BaseURL
 
BaseURLBase - Class in com.liferay.faces.portlet.component.baseurl
 
BaseURLBase() - Constructor for class com.liferay.faces.portlet.component.baseurl.BaseURLBase
 
BaseURLBase.BaseURLPropertyKeys - Enum in com.liferay.faces.portlet.component.baseurl
 
Bridge - Interface in javax.portlet.faces
The Bridge interface is used by a portlet to execute a JSF application.
Bridge.PortletPhase - Enum in javax.portlet.faces
Enumeration whose values describe the current portlet phase the bridge is executing Faces within.
BRIDGE_AUTO_DISPATCH_EVENTS - Static variable in class javax.portlet.faces.GenericFacesPortlet
Portlet init-param containing the setting for whether the GenericFacesPortlet overrides event processing by dispatching all events to the bridge or delegates all event processing to the GenericPortlet.
BRIDGE_CLASS - Static variable in class javax.portlet.faces.GenericFacesPortlet
Application (PortletContext) init parameter that names the bridge class used by this application.
BRIDGE_EVENT_HANDLER - Static variable in interface javax.portlet.faces.Bridge
Deprecated.
Call ExternalContext.getInitParameter(String) with parameter value "javax.portlet.faces.bridgeEventHandler" instead.

Portlet context attribute that a portlet can set prior to calling Bridge.init(PortletConfig) to configure the bridge to use/call the associated BridgeEventHandler when processing an event. Value is an instance of BridgeEventHandler. As this attribute is scoped to a specific portlet in an application-wide context the attribute name must be include the portlet name as follows:

"javax.portlet.faces." + portletContext.getPortletName() + ".bridgeEventHandler"
BRIDGE_PACKAGE_PREFIX - Static variable in interface javax.portlet.faces.Bridge
Base attribute/context parameter prefix.
BRIDGE_PUBLIC_RENDER_PARAMETER_HANDLER - Static variable in interface javax.portlet.faces.Bridge
Deprecated.
Call ExternalContext.getInitParameter(String) with parameter value "javax.portlet.faces.bridgePublicRenderParameterHandler" instead.

Portlet context attribute that a portlet can set prior to calling the Bridge.init(PortletConfig) method to configure the bridge to use/call the associated BridgePublicRenderParameterHandler. This handler is used to process updates that result from public render parameter changes passed in a request. The bridge first pushs all the public render parameter values into the models and then calls this handler's processUpdates method. The handler can then compute further model changes based on the changes. Value is an instance of BridgePublicRenderParameterHandler. As this attribute is scoped to a specific portlet in an application-wide context the attribute name must be include the portlet name as follows:

"javax.portlet.faces." + portletContext.getPortletName() + ".bridgeEventHandler"
BRIDGE_SERVICE_CLASSPATH - Static variable in class javax.portlet.faces.GenericFacesPortlet
Location of the services descriptor file in a brige installation that defines the class name of the bridge implementation.
BridgeConfig - Interface in com.liferay.faces.bridge
 
BridgeConfigFactory - Class in com.liferay.faces.bridge
This abstract class provides a contract for defining a factory that knows how to create instances of type BridgeConfig and PortletConfig.
BridgeConfigFactory() - Constructor for class com.liferay.faces.bridge.BridgeConfigFactory
 
BridgeConfigWrapper - Class in com.liferay.faces.bridge
 
BridgeConfigWrapper() - Constructor for class com.liferay.faces.bridge.BridgeConfigWrapper
 
BridgeDefaultViewNotSpecifiedException - Exception in javax.portlet.faces
Thrown when the bridge can't resolve the target view from the request and the portlet hasn't set the portlet request attribute GenericFacesPortlet.DEFAULT_VIEWID.
BridgeDefaultViewNotSpecifiedException() - Constructor for exception javax.portlet.faces.BridgeDefaultViewNotSpecifiedException
 
BridgeDefaultViewNotSpecifiedException(String) - Constructor for exception javax.portlet.faces.BridgeDefaultViewNotSpecifiedException
 
BridgeDefaultViewNotSpecifiedException(Exception) - Constructor for exception javax.portlet.faces.BridgeDefaultViewNotSpecifiedException
 
BridgeDefaultViewNotSpecifiedException(Throwable) - Constructor for exception javax.portlet.faces.BridgeDefaultViewNotSpecifiedException
 
BridgeDefaultViewNotSpecifiedException(String, Throwable) - Constructor for exception javax.portlet.faces.BridgeDefaultViewNotSpecifiedException
 
BridgeEventHandler - Interface in javax.portlet.faces
The BridgeEventHandler interface defines the class the bridge relies on to process portlet events.
BridgeEventHandlerFactory - Class in com.liferay.faces.bridge
 
BridgeEventHandlerFactory() - Constructor for class com.liferay.faces.bridge.BridgeEventHandlerFactory
 
BridgeEventHandlerWrapper - Class in com.liferay.faces.bridge
 
BridgeEventHandlerWrapper() - Constructor for class com.liferay.faces.bridge.BridgeEventHandlerWrapper
 
BridgeException - Exception in javax.portlet.faces
Generic exception thrown when the bridge encounters an unexpected error.
BridgeException() - Constructor for exception javax.portlet.faces.BridgeException
 
BridgeException(String) - Constructor for exception javax.portlet.faces.BridgeException
 
BridgeException(Exception) - Constructor for exception javax.portlet.faces.BridgeException
 
BridgeException(Throwable) - Constructor for exception javax.portlet.faces.BridgeException
 
BridgeException(String, Throwable) - Constructor for exception javax.portlet.faces.BridgeException
 
BridgeFactoryFinder - Class in com.liferay.faces.bridge
This class provides a factory lookup mechanism similar to the FactoryFinder in the JSF API.
BridgeFactoryFinder() - Constructor for class com.liferay.faces.bridge.BridgeFactoryFinder
 
BridgeInvalidViewPathException - Exception in javax.portlet.faces
Thrown when the bridge can't resolve the target view from the ViewPath portlet request attribute Bridge.FACES_VIEW_PATH_PARAMETER.
BridgeInvalidViewPathException() - Constructor for exception javax.portlet.faces.BridgeInvalidViewPathException
 
BridgeInvalidViewPathException(String) - Constructor for exception javax.portlet.faces.BridgeInvalidViewPathException
 
BridgeInvalidViewPathException(Exception) - Constructor for exception javax.portlet.faces.BridgeInvalidViewPathException
 
BridgeInvalidViewPathException(Throwable) - Constructor for exception javax.portlet.faces.BridgeInvalidViewPathException
 
BridgeInvalidViewPathException(String, Throwable) - Constructor for exception javax.portlet.faces.BridgeInvalidViewPathException
 
BridgeNotAFacesRequestException - Exception in javax.portlet.faces
Thrown when the portlet invokes one of the bridge's doFacesRequest methods even though the Bridge.NONFACES_TARGET_PATH_PARAMETER parameter is present, indicating it is a non-Faces target.
BridgeNotAFacesRequestException() - Constructor for exception javax.portlet.faces.BridgeNotAFacesRequestException
 
BridgeNotAFacesRequestException(String) - Constructor for exception javax.portlet.faces.BridgeNotAFacesRequestException
 
BridgeNotAFacesRequestException(Exception) - Constructor for exception javax.portlet.faces.BridgeNotAFacesRequestException
 
BridgeNotAFacesRequestException(Throwable) - Constructor for exception javax.portlet.faces.BridgeNotAFacesRequestException
 
BridgeNotAFacesRequestException(String, Throwable) - Constructor for exception javax.portlet.faces.BridgeNotAFacesRequestException
 
BridgePortalContext - Class in com.liferay.faces.bridge.context
 
BridgePortletConfigFactory - Class in com.liferay.faces.bridge.filter
 
BridgePortletConfigFactory() - Constructor for class com.liferay.faces.bridge.filter.BridgePortletConfigFactory
 
BridgePortletContextFactory - Class in com.liferay.faces.bridge.filter
Deprecated.
Instead, register a custom BridgePortletConfigFactory that provides a custom instance of PortletConfig, that in turn provides a method Override for PortletConfig.getPortletContext().
BridgePortletContextFactory() - Constructor for class com.liferay.faces.bridge.filter.BridgePortletContextFactory
Deprecated.
 
BridgePortletRequestFactory - Class in com.liferay.faces.bridge.filter
 
BridgePortletRequestFactory() - Constructor for class com.liferay.faces.bridge.filter.BridgePortletRequestFactory
 
BridgePortletResponseFactory - Class in com.liferay.faces.bridge.filter
 
BridgePortletResponseFactory() - Constructor for class com.liferay.faces.bridge.filter.BridgePortletResponseFactory
 
BridgePreDestroy - Annotation Type in javax.portlet.faces.annotation
The BridgePreDestroy annotation is used on methods as a callback notification to signal that the instance is in the process of being removed by the bridge from the bridge request scope.
BridgePublicRenderParameterHandler - Interface in javax.portlet.faces
This interface defines the contract for a Portlet 2.0 Public Render Parameter "handler" that enables JSF portlet developers to perform any processing that might be necessary after the bridge pushes public render parameter values into the model.
BridgePublicRenderParameterHandlerFactory - Class in com.liferay.faces.bridge
 
BridgePublicRenderParameterHandlerFactory() - Constructor for class com.liferay.faces.bridge.BridgePublicRenderParameterHandlerFactory
 
BridgePublicRenderParameterHandlerWrapper - Class in com.liferay.faces.bridge
 
BridgePublicRenderParameterHandlerWrapper() - Constructor for class com.liferay.faces.bridge.BridgePublicRenderParameterHandlerWrapper
 
BridgeRequestScopeAttributeAdded - Annotation Type in javax.portlet.faces.annotation
The BridgeRequestScopeAttributeAdded annotation is used on methods as a callback notification to signal that the instance is in the process of being added to the container's request scope and that this attribute will be managed in the bridge request scope.
BridgeUninitializedException - Exception in javax.portlet.faces
Thrown when the one of the bridge's doFacesRequest methods is called and the bridge is in an uninitialized state.
BridgeUninitializedException() - Constructor for exception javax.portlet.faces.BridgeUninitializedException
 
BridgeUninitializedException(String) - Constructor for exception javax.portlet.faces.BridgeUninitializedException
 
BridgeUninitializedException(Exception) - Constructor for exception javax.portlet.faces.BridgeUninitializedException
 
BridgeUninitializedException(Throwable) - Constructor for exception javax.portlet.faces.BridgeUninitializedException
 
BridgeUninitializedException(String, Throwable) - Constructor for exception javax.portlet.faces.BridgeUninitializedException
 
BridgeURL - Interface in com.liferay.faces.bridge
This interface represents a bridge URL, meaning a URL that has convenience methods for representing URLs according to Section 6.1.3.1 of the Bridge Spec.
BridgeURLFactory - Class in com.liferay.faces.bridge
This factory is responsible for creating instances of BridgeURL.
BridgeURLFactory() - Constructor for class com.liferay.faces.bridge.BridgeURLFactory
 
BridgeURLWrapper - Class in com.liferay.faces.bridge
 
BridgeURLWrapper() - Constructor for class com.liferay.faces.bridge.BridgeURLWrapper
 
BridgeUtil - Class in javax.portlet.faces
Utility class designed to make it easy for Faces subsystems including the bridge itself to determine whether this request is running in a portlet container and/or which portlet request phase it is executing in.
broadcast(FacesEvent) - Method in class com.liferay.faces.bridge.component.inputfile.InputFile
 

C

com.liferay.faces.bridge - package com.liferay.faces.bridge
 
com.liferay.faces.bridge.component.inputfile - package com.liferay.faces.bridge.component.inputfile
 
com.liferay.faces.bridge.context - package com.liferay.faces.bridge.context
 
com.liferay.faces.bridge.event - package com.liferay.faces.bridge.event
 
com.liferay.faces.bridge.filter - package com.liferay.faces.bridge.filter
 
com.liferay.faces.bridge.model - package com.liferay.faces.bridge.model
 
com.liferay.faces.portlet.component.actionurl - package com.liferay.faces.portlet.component.actionurl
 
com.liferay.faces.portlet.component.baseurl - package com.liferay.faces.portlet.component.baseurl
 
com.liferay.faces.portlet.component.namespace - package com.liferay.faces.portlet.component.namespace
 
com.liferay.faces.portlet.component.param - package com.liferay.faces.portlet.component.param
 
com.liferay.faces.portlet.component.portleturl - package com.liferay.faces.portlet.component.portleturl
 
com.liferay.faces.portlet.component.property - package com.liferay.faces.portlet.component.property
 
com.liferay.faces.portlet.component.renderurl - package com.liferay.faces.portlet.component.renderurl
 
com.liferay.faces.portlet.component.resourceurl - package com.liferay.faces.portlet.component.resourceurl
 
COMPONENT_FAMILY - Static variable in class com.liferay.faces.portlet.component.baseurl.BaseURLBase
 
COMPONENT_FAMILY - Static variable in class com.liferay.faces.portlet.component.namespace.NamespaceBase
 
COMPONENT_FAMILY - Static variable in class com.liferay.faces.portlet.component.param.ParamBase
 
COMPONENT_FAMILY - Static variable in class com.liferay.faces.portlet.component.property.PropertyBase
 
COMPONENT_TYPE - Static variable in class com.liferay.faces.bridge.component.inputfile.InputFileBase
 
COMPONENT_TYPE - Static variable in class com.liferay.faces.portlet.component.actionurl.ActionURLBase
 
COMPONENT_TYPE - Static variable in class com.liferay.faces.portlet.component.baseurl.BaseURLBase
 
COMPONENT_TYPE - Static variable in class com.liferay.faces.portlet.component.namespace.NamespaceBase
 
COMPONENT_TYPE - Static variable in class com.liferay.faces.portlet.component.param.ParamBase
 
COMPONENT_TYPE - Static variable in class com.liferay.faces.portlet.component.portleturl.PortletURLBase
 
COMPONENT_TYPE - Static variable in class com.liferay.faces.portlet.component.property.PropertyBase
 
COMPONENT_TYPE - Static variable in class com.liferay.faces.portlet.component.renderurl.RenderURLBase
 
COMPONENT_TYPE - Static variable in class com.liferay.faces.portlet.component.resourceurl.ResourceURLBase
 
containsExcludedNamespace(String) - Method in interface com.liferay.faces.bridge.RequestAttributeInspector
Determines whether or not a request attribute is to be excluded from the bridge request scope because the specified name name starts with a particular sequence of characters (a namespace).
containsExcludedNamespace(String) - Method in class com.liferay.faces.bridge.RequestAttributeInspectorWrapper
 
CREATE_RENDER_URL_DURING_ACTION_PHASE_SUPPORT - Static variable in class com.liferay.faces.bridge.context.BridgePortalContext
Property indicating if the portal application supports creation of a render URL during the PortletRequest.ACTION_PHASE of the portlet lifecycle.

D

DEFAULT_CHARACTERSET_ENCODING - Static variable in class javax.portlet.faces.GenericFacesPortlet
Deprecated.
Portlet init parameter that defines the render response CharacterSetEncoding the bridge sets prior to rendering. Typcially only set when the jsp outputs an encoding other then the portlet container's and the portlet container supports response encoding transformation. It is deprecated because bridge implementations (since JSR 329) no longer utilize it.
DEFAULT_CONTENT_TYPE - Static variable in class javax.portlet.faces.GenericFacesPortlet
Deprecated.
Portlet init parameter that defines the render response ContentType the bridge sets prior to rendering. If not set the bridge uses the request's preferred content type. It is deprecated because bridge implementations (since JSR 329) no longer utilize it.
DEFAULT_RENDERKIT_ID - Static variable in interface javax.portlet.faces.Bridge
Deprecated.
Call ExternalContext.getInitParameter(String) with parameter value "javax.portlet.faces.defaultRenderKitId" instead.

Portlet context attribute that a portlet can set prior to calling the Bridge.init(PortletConfig) method to configure the bridge to default the renderKitId used for rendering this portlet to the named Id. In Faces, the default renderKitId is set in the faces-config.xml and is application wide. In 1.2 this can be overidden by a specially named request parameter. To allow differing portlets in the same app to use different default render kits, without having to add this parameter, the portlet can set this attribute prior to the bridge init(). The bridge will recognize this configuration value and on each request add the special faces request parameter to the request (if its not already present).

DEFAULT_VIEWID - Static variable in class javax.portlet.faces.GenericFacesPortlet
Portlet init parameter that defines the default ViewId that should be used when the request doesn't otherwise convery the target.
DEFAULT_VIEWID_MAP - Static variable in interface javax.portlet.faces.Bridge
Deprecated.
Call ExternalContext.getInitParameter(String) with parameter "javax.portlet.faces.defaultViewId.view", "javax.portlet.faces.defaultViewId.edit", or "javax.portlet.faces.defaultViewId.help", etc.

Portlet context attribute that a portlet must set prior to calling Bridge.init(PortletConfig) to convey to the bridge the set of default viewIds that correspond to this portlet's supported portlet modes. Its value is a Map with one entry per mode. The mode name is the key. The entry's value is the corresponding default viewId the bridge should use for this mode. As this attribute is scoped to a specific portlet in an application-wide context the attribute name must be include the portlet name as follows:

"javax.portlet.faces." + portletContext.getPortletName() + ".defaultViewIdMap"
delete() - Method in interface com.liferay.faces.bridge.model.UploadedFile
 
destroy() - Method in interface javax.portlet.faces.Bridge
Called by the portlet to take the bridge out of service.
destroy() - Method in class javax.portlet.faces.GenericFacesPortlet
Release resources, specifically it destroys the bridge.
DIRECT_LINK - Static variable in interface javax.portlet.faces.Bridge
Special token parameter in the URL passed to the bridge's implementation of ExternalContext.encodeActionURL(String) that it recognizes as an indication that this action should be treated as a direct link and hence shouldn't be encoded as a Portlet action.
doDispatch(RenderRequest, RenderResponse) - Method in class javax.portlet.faces.GenericFacesPortlet
If the javax.portlet.faces.automaticNonFacesViewDispatching init-param is true and the Bridge.NONFACES_TARGET_PATH_PARAMETER render request parameter specifies a value as a non-Faces target path, then forward to the non-Faces target path.
doEdit(RenderRequest, RenderResponse) - Method in class javax.portlet.faces.GenericFacesPortlet
Delegates to Bridge.doFacesRequest(RenderRequest, RenderResponse) in order to render the Faces view associated with PortletMode.EDIT.
doFacesRequest(ActionRequest, ActionResponse) - Method in interface javax.portlet.faces.Bridge
Called by the portlet when it wants the bridge to invoke action request/response processing.
doFacesRequest(EventRequest, EventResponse) - Method in interface javax.portlet.faces.Bridge
Called by the portlet when it wants the bridge to invoke event request/response processing.
doFacesRequest(RenderRequest, RenderResponse) - Method in interface javax.portlet.faces.Bridge
Called by the portlet when it wants the bridge to invoke render request/response processing.
doFacesRequest(ResourceRequest, ResourceResponse) - Method in interface javax.portlet.faces.Bridge
Called by the portlet when it wants the bridge to invoke resource request/response processing.
doHeaders(RenderRequest, RenderResponse) - Method in class javax.portlet.faces.GenericFacesPortlet
 
doHelp(RenderRequest, RenderResponse) - Method in class javax.portlet.faces.GenericFacesPortlet
Delegates to Bridge.doFacesRequest(RenderRequest, RenderResponse) in order to render the Faces view associated with PortletMode.HELP.
doView(RenderRequest, RenderResponse) - Method in class javax.portlet.faces.GenericFacesPortlet
Delegates to Bridge.doFacesRequest(RenderRequest, RenderResponse) in order to render the Faces view associated with PortletMode.VIEW.

E

EventNavigationResult - Class in javax.portlet.faces.event
An EventNavigationResult is the type of object that can be returned from a BridgeEventHandler.handleEvent(FacesContext, Event) call.
EventNavigationResult() - Constructor for class javax.portlet.faces.event.EventNavigationResult
 
EventNavigationResult(String, String) - Constructor for class javax.portlet.faces.event.EventNavigationResult
Constructor which sets the object to the desired fromAction and outcome.
EventPayloadWrapper - Class in com.liferay.faces.bridge.event
The purpose of this class is to provide support a vendor-specific feature of Liferay Portal that provides the ability to broadcast Portlet 2.0 Events to portlets that exist on a different portal page.
EventPayloadWrapper(Serializable, boolean) - Constructor for class com.liferay.faces.bridge.event.EventPayloadWrapper
Constructs a new EventPayloadWrapper instance.
EXCLUDED_REQUEST_ATTRIBUTES - Static variable in interface javax.portlet.faces.Bridge
Deprecated.
Call ExternalContext.getInitParameter(String) with parameter value "javax.portlet.faces.excludedRequestAttributes" instead.

Portlet context attribute that a portlet can set prior to calling Bridge.init(PortletConfig) to configure the bridge to exclude specific attributes from its bridge request scope. Value is a comma delimited list containing either a fully qualified attribute name or package name terminated with a ".*" wildcard indicator. In this later case, all attributes in the package name which precedes the ".*" are excluded, non recursive. As this attribute is scoped to a specific portlet in an application-wide context the attribute name must be include the portlet name as follows:

"javax.portlet.faces." + portletContext.getPortletName() + ".excludedRequestAttributes"
ExcludeFromManagedRequestScope - Annotation Type in javax.portlet.faces.annotation
The ExcludeFromManagedRequestScope annotation is used on a class as a signal that instances of this class are not to be managed by the bridge in the bridge request scope if/when the instance is added to the portlet container's request scope.

F

FACES_AJAX_PARAMETER - Static variable in interface javax.portlet.faces.Bridge
Request parameter that can be set on a ResourceURL.
FACES_PARTIAL_PARAMETER - Static variable in interface javax.portlet.faces.Bridge
Request parameter that can be set on a ResourceURL.
FACES_USE_CURRENT_VIEW_PARAMETER - Static variable in interface javax.portlet.faces.Bridge
Special value recognized when encoding an action URL: It is a URL that contains either the Bridge.FACES_VIEW_ID_PARAMETER or Bridge.FACES_VIEW_PATH_PARAMETER.
FACES_VIEW_ID_PARAMETER - Static variable in interface javax.portlet.faces.Bridge
Name of a request parameter (generally) encoded in a link from a non-Faces view response.
FACES_VIEW_PATH_PARAMETER - Static variable in interface javax.portlet.faces.Bridge
Name of a request parameter (generally) encoded in a link from a non-Faces view response.
FileUploadEvent - Class in com.liferay.faces.bridge.event
 
FileUploadEvent(UIComponent, UploadedFile) - Constructor for class com.liferay.faces.bridge.event.FileUploadEvent
 

G

GenericFacesPortlet - Class in javax.portlet.faces
The GenericFacesPortlet is provided to simplify development of a portlet that in whole or part relies on the Faces Bridge to process requests.
GenericFacesPortlet() - Constructor for class javax.portlet.faces.GenericFacesPortlet
 
getAbsolutePath() - Method in interface com.liferay.faces.bridge.model.UploadedFile
 
getActionRequest(ActionRequest, ActionResponse, PortletConfig, BridgeConfig) - Method in class com.liferay.faces.bridge.filter.BridgePortletRequestFactory
Returns a new instance of ActionRequest.
getActionRequestInstance(ActionRequest, ActionResponse, PortletConfig, BridgeConfig) - Static method in class com.liferay.faces.bridge.filter.BridgePortletRequestFactory
Returns a new instance of ActionRequest from the BridgePortletRequestFactory found by the BridgeFactoryFinder.
getActionResponse(ActionRequest, ActionResponse, PortletConfig, BridgeConfig) - Method in class com.liferay.faces.bridge.filter.BridgePortletResponseFactory
Returns a new instance of ActionResponse.
getActionResponseInstance(ActionRequest, ActionResponse, PortletConfig, BridgeConfig) - Static method in class com.liferay.faces.bridge.filter.BridgePortletResponseFactory
Returns a new instance of ActionResponse from the BridgePortletResponseFactory found by the BridgeFactoryFinder.
getAttributes() - Method in interface com.liferay.faces.bridge.BridgeConfig
Returns an immutable Map of bridge configuration attributes.
getAttributes() - Method in class com.liferay.faces.bridge.BridgeConfigWrapper
 
getAttributes() - Method in interface com.liferay.faces.bridge.model.UploadedFile
 
getBridgeActionURL(FacesContext, String) - Method in class com.liferay.faces.bridge.BridgeURLFactory
Returns a new action URL instance of BridgeURL.
getBridgeActionURLInstance(FacesContext, String) - Static method in class com.liferay.faces.bridge.BridgeURLFactory
Returns a new action URL instance of BridgeURL from the BridgeURLFactory found by the BridgeFactoryFinder.
getBridgeBookmarkableURL(FacesContext, String, Map<String, List<String>>) - Method in class com.liferay.faces.bridge.BridgeURLFactory
Returns a new bookmarkable URL instance of BridgeURL.
getBridgeBookmarkableURLInstance(FacesContext, String, Map<String, List<String>>) - Static method in class com.liferay.faces.bridge.BridgeURLFactory
Returns a new bookmarkable URL instance of BridgeURL from the BridgeURLFactory found by the BridgeFactoryFinder.
getBridgeClassName() - Method in class javax.portlet.faces.GenericFacesPortlet
Returns the className of the bridge implementation this portlet uses.
getBridgeConfig(PortletConfig) - Method in class com.liferay.faces.bridge.BridgeConfigFactory
Returns a thread-safe instance of BridgeConfig.
getBridgeConfigInstance(PortletConfig) - Static method in class com.liferay.faces.bridge.BridgeConfigFactory
Returns a thread-safe instance of BridgeConfig from the BridgeConfigFactory found by the BridgeFactoryFinder.
getBridgeEventHandler(PortletConfig) - Method in class com.liferay.faces.bridge.BridgeEventHandlerFactory
Returns a thread-safe instance of BridgeEventHandler.
getBridgeEventHandler() - Method in class javax.portlet.faces.GenericFacesPortlet
Deprecated.
Call BridgeEventHandlerFactory.getBridgeEventHandler(PortletConfig) instead.

Returns an instance of a BridgeEventHandler used to process portlet events in a JSF environment. This default implementation looks for a portlet initParameter that names the class used to instantiate the handler.

Note that this method will only be called by GenericFacesPortlet.init(PortletConfig) if the GenericFacesPortlet.INITIALIZE_NAMESPACED_CONTEXT_ATTRIBUTES init-param is true in WEB-INF/portlet.xml.

getBridgeEventHandlerInstance(PortletConfig) - Static method in class com.liferay.faces.bridge.BridgeEventHandlerFactory
Returns a thread-safe instance of BridgeEventHandler from the BridgeEventHandlerFactory found by the BridgeFactoryFinder.
getBridgePartialActionURL(FacesContext, String) - Method in class com.liferay.faces.bridge.BridgeURLFactory
Returns a new partial action URL instance of BridgeURL.
getBridgePartialActionURLInstance(FacesContext, String) - Static method in class com.liferay.faces.bridge.BridgeURLFactory
Returns a new partial action URL instance of BridgeURL from the BridgeURLFactory found by the BridgeFactoryFinder.
getBridgePublicRenderParameterHandler(PortletConfig) - Method in class com.liferay.faces.bridge.BridgePublicRenderParameterHandlerFactory
Returns a thread-safe instance of BridgePublicRenderParameterHandler.
getBridgePublicRenderParameterHandler() - Method in class javax.portlet.faces.GenericFacesPortlet
Deprecated.
Call BridgePublicRenderParameterHandlerFactory.getBridgePublicRenderParameterHandler(PortletConfig) instead.

Returns an instance of a BridgePublicRenderParameterHandler used to post process public render parameter changes that the bridge has pushed into mapped models. This default implementation looks for a portlet initParameter that names the class used to instantiate the handler.

Note that this method will only be called by GenericFacesPortlet.init(PortletConfig) if the GenericFacesPortlet.INITIALIZE_NAMESPACED_CONTEXT_ATTRIBUTES init-param is true in WEB-INF/portlet.xml.

getBridgePublicRenderParameterHandlerInstance(PortletConfig) - Static method in class com.liferay.faces.bridge.BridgePublicRenderParameterHandlerFactory
getBridgeRedirectURL(FacesContext, String, Map<String, List<String>>) - Method in class com.liferay.faces.bridge.BridgeURLFactory
Returns a new redirect URL instance of BridgeURL.
getBridgeRedirectURLInstance(FacesContext, String, Map<String, List<String>>) - Static method in class com.liferay.faces.bridge.BridgeURLFactory
Returns a new redirect URL instance of BridgeURL from the BridgeURLFactory found by the BridgeFactoryFinder.
getBridgeResourceURL(FacesContext, String) - Method in class com.liferay.faces.bridge.BridgeURLFactory
Returns a new resource URL instance of BridgeURL.
getBridgeResourceURLInstance(FacesContext, String) - Static method in class com.liferay.faces.bridge.BridgeURLFactory
Returns a new resource URL instance of BridgeURL from the BridgeURLFactory found by the BridgeFactoryFinder.
getBytes() - Method in interface com.liferay.faces.bridge.model.UploadedFile
 
getCacheability() - Method in class com.liferay.faces.portlet.component.resourceurl.ResourceURLBase
cacheability attribute description:
getCharSet() - Method in interface com.liferay.faces.bridge.model.UploadedFile
 
getContainerClientId(FacesContext) - Method in class javax.portlet.faces.component.PortletNamingContainerUIViewRoot
 
getContentType() - Method in interface com.liferay.faces.bridge.model.UploadedFile
 
getDefaultRenderKitId() - Method in class javax.portlet.faces.GenericFacesPortlet
Deprecated.
Call ExternalContext.getInitParameter(String) with parameter value "javax.portlet.faces.defaultRenderKitId" instead.

Returns a String defining the default render kit id the bridge should ensure for this portlet. If non-null, this value is used to override any default render kit id set on an app wide basis in the faces-config.xml. This default implementation reads the values from the portlet init-param javax.portlet.faces.defaultRenderKitId. If not present, null is returned.

Note that this method will only be called by GenericFacesPortlet.init(PortletConfig) if the GenericFacesPortlet.INITIALIZE_NAMESPACED_CONTEXT_ATTRIBUTES init-param is true in WEB-INF/portlet.xml.

getDefaultViewIdMap() - Method in class javax.portlet.faces.GenericFacesPortlet
Deprecated.
Call ExternalContext.getInitParameter(String) with parameter "javax.portlet.faces.defaultViewId.view", "javax.portlet.faces.defaultViewId.edit", or "javax.portlet.faces.defaultViewId.help", etc.

Returns a map of default viewIds that the bridge should use when it is unable to resolve to a specific target in the incoming request. There is one entry per support PortletMode. The entry key is the name of the mode. The entry value is the default viewId for that mode.

Note that this method will only be called by GenericFacesPortlet.init(PortletConfig) if the GenericFacesPortlet.INITIALIZE_NAMESPACED_CONTEXT_ATTRIBUTES init-param is true in WEB-INF/portlet.xml.

getEventRequest(EventRequest, EventResponse, PortletConfig, BridgeConfig) - Method in class com.liferay.faces.bridge.filter.BridgePortletRequestFactory
Returns a new instance of EventRequest.
getEventRequestInstance(EventRequest, EventResponse, PortletConfig, BridgeConfig) - Static method in class com.liferay.faces.bridge.filter.BridgePortletRequestFactory
Returns a new instance of EventRequest from the BridgePortletRequestFactory found by the BridgeFactoryFinder.
getEventResponse(EventRequest, EventResponse, PortletConfig, BridgeConfig) - Method in class com.liferay.faces.bridge.filter.BridgePortletResponseFactory
Returns a new instance of EventResponse.
getEventResponseInstance(EventRequest, EventResponse, PortletConfig, BridgeConfig) - Static method in class com.liferay.faces.bridge.filter.BridgePortletResponseFactory
Returns a new instance of EventResponse from the BridgePortletResponseFactory found by the BridgeFactoryFinder.
getExcludedRequestAttributes() - Method in interface com.liferay.faces.bridge.BridgeConfig
Returns an immutable Set of attribute names that are to be excluded from the bridge request scope as defined in the bridge:excluded-attributes element within the faces-config.xml descriptor.
getExcludedRequestAttributes() - Method in class com.liferay.faces.bridge.BridgeConfigWrapper
 
getExcludedRequestAttributes() - Method in class javax.portlet.faces.GenericFacesPortlet
Deprecated.
Call ExternalContext.getInitParameter(String) with parameter "javax.portlet.faces.excludedRequestAttributes" instead.

Returns the set of RequestAttribute names that the portlet wants the bridge to exclude from its managed request scope. This default implementation picks up this list from the comma delimited init-param javax.portlet.faces.excludedRequestAttributes.

Note that this method will only be called by GenericFacesPortlet.init(PortletConfig) if the GenericFacesPortlet.INITIALIZE_NAMESPACED_CONTEXT_ATTRIBUTES init-param is true in WEB-INF/portlet.xml.

getFacesBridge(PortletRequest, PortletResponse) - Method in class javax.portlet.faces.GenericFacesPortlet
Returns an initialized bridge instance adequately prepared so the caller can call doFacesRequest directly without further initialization.
getFactory(Class<?>) - Static method in class com.liferay.faces.bridge.BridgeFactoryFinder
Deprecated.
Call BridgeFactoryFinder.getFactory(PortletContext, Class) instead.

Returns the factory instance associated with the specified factory class from the portlet context associated with the current portlet request.

getFactory(PortletContext, Class<?>) - Static method in class com.liferay.faces.bridge.BridgeFactoryFinder
Returns the factory instance associated with the specified factory class from the specified portlet context.
getFactoryInstance(Class<?>) - Method in class com.liferay.faces.bridge.BridgeFactoryFinder
Deprecated.
Call BridgeFactoryFinder.getFactory(PortletContext, Class) instead.

Returns the factory instance associated with the specified factory class from the portlet context associated with the current portlet request.

getFactoryInstance(PortletContext, Class<?>) - Method in class com.liferay.faces.bridge.BridgeFactoryFinder
Returns the factory instance associated with the specified factory class from the specified portlet context.
getFamily() - Method in class com.liferay.faces.portlet.component.baseurl.BaseURLBase
 
getFamily() - Method in class com.liferay.faces.portlet.component.namespace.NamespaceBase
 
getFamily() - Method in class com.liferay.faces.portlet.component.param.ParamBase
 
getFamily() - Method in class com.liferay.faces.portlet.component.property.PropertyBase
 
getFileUploadListener() - Method in class com.liferay.faces.bridge.component.inputfile.InputFileBase
fileUploadListener attribute description:
getFromAction() - Method in class javax.portlet.faces.event.EventNavigationResult
 
getHeader(String) - Method in interface com.liferay.faces.bridge.model.UploadedFile
 
getHeaderNames() - Method in interface com.liferay.faces.bridge.model.UploadedFile
 
getHeaders(String) - Method in interface com.liferay.faces.bridge.model.UploadedFile
 
getHeadResponseWriter(ResponseWriter, PortletResponse) - Method in class com.liferay.faces.bridge.context.HeadResponseWriterFactory
Returns a new instance of ResponseWriter.
getHeadResponseWriterInstance(ResponseWriter, PortletContext, PortletResponse) - Static method in class com.liferay.faces.bridge.context.HeadResponseWriterFactory
Returns a new instance of ResponseWriter from the HeadResponseWriterFactory found by the BridgeFactoryFinder.
getId() - Method in interface com.liferay.faces.bridge.model.UploadedFile
 
getId() - Method in class com.liferay.faces.portlet.component.resourceurl.ResourceURLBase
id attribute description:
getInputStream() - Method in interface com.liferay.faces.bridge.model.UploadedFile
 
getInstance() - Static method in class com.liferay.faces.bridge.BridgeFactoryFinder
Returns the thread-safe Singleton instance of the bridge factory finder.
getMessage() - Method in interface com.liferay.faces.bridge.model.UploadedFile
 
getMultiple() - Method in class com.liferay.faces.bridge.component.inputfile.InputFileBase
 
getName() - Method in interface com.liferay.faces.bridge.model.UploadedFile
 
getName() - Method in class com.liferay.faces.portlet.component.actionurl.ActionURLBase
name attribute description:
getName() - Method in class com.liferay.faces.portlet.component.param.ParamBase
name attribute description:
getName() - Method in class com.liferay.faces.portlet.component.property.PropertyBase
name attribute description:
getName() - Method in interface javax.portlet.faces.preference.Preference
Returns the name of this preference.
getOutcome() - Method in class javax.portlet.faces.event.EventNavigationResult
 
getParameter(String) - Method in interface com.liferay.faces.bridge.BridgeURL
Returns the first value of the underlying BridgeURL.getParameterMap() with the specified name.
getParameter(String) - Method in class com.liferay.faces.bridge.BridgeURLWrapper
 
getParameterMap() - Method in interface com.liferay.faces.bridge.BridgeURL
Returns a mutable Map representing the URL parameters.
getParameterMap() - Method in class com.liferay.faces.bridge.BridgeURLWrapper
 
getPortletConfig(PortletConfig) - Method in class com.liferay.faces.bridge.filter.BridgePortletConfigFactory
Returns a thread-safe instance of PortletConfig.
getPortletConfigInstance(PortletConfig) - Static method in class com.liferay.faces.bridge.filter.BridgePortletConfigFactory
Returns a thread-safe instance of PortletConfig from the BridgePortletConfigFactory found by the BridgeFactoryFinder.
getPortletContext(PortletContext) - Method in class com.liferay.faces.bridge.filter.BridgePortletContextFactory
Deprecated.
Returns a thread-safe instance of PortletContext.
getPortletContextInstance(PortletContext) - Static method in class com.liferay.faces.bridge.filter.BridgePortletContextFactory
Deprecated.
Returns a thread-safe instance of PortletContext from the BridgePortletContextFactory found by the BridgeFactoryFinder.
getPortletMode() - Method in class com.liferay.faces.portlet.component.portleturl.PortletURLBase
portletMode attribute description:
getPortletRequestPhase() - Static method in class javax.portlet.faces.BridgeUtil
Indicates the portlet lifecycle phase currently being executed within the execution of the Faces lifecycle.
getPortletRequestPhase(FacesContext) - Static method in class javax.portlet.faces.BridgeUtil
Indicates the portlet lifecycle phase currently being executed within the execution of the Faces lifecycle.
getPublicParameterMappings() - Method in interface com.liferay.faces.bridge.BridgeConfig
Returns an immutable Map of Public Render Parameter mappings as defined in the bridge:public-parameter-mappings element of the faces-config.xml descriptor.
getPublicParameterMappings() - Method in class com.liferay.faces.bridge.BridgeConfigWrapper
 
getRenderRequest(RenderRequest, RenderResponse, PortletConfig, BridgeConfig) - Method in class com.liferay.faces.bridge.filter.BridgePortletRequestFactory
Returns a new instance of RenderRequest.
getRenderRequestInstance(RenderRequest, RenderResponse, PortletConfig, BridgeConfig) - Static method in class com.liferay.faces.bridge.filter.BridgePortletRequestFactory
Returns a new instance of RenderRequest from the BridgePortletRequestFactory found by the BridgeFactoryFinder.
getRenderResponse(RenderRequest, RenderResponse, PortletConfig, BridgeConfig) - Method in class com.liferay.faces.bridge.filter.BridgePortletResponseFactory
Returns a new instance of RenderResponse.
getRenderResponseInstance(RenderRequest, RenderResponse, PortletConfig, BridgeConfig) - Static method in class com.liferay.faces.bridge.filter.BridgePortletResponseFactory
Returns a new instance of RenderResponse from the BridgePortletResponseFactory found by the BridgeFactoryFinder.
getRequestAttributeInspector(PortletRequest, PortletConfig, BridgeConfig) - Method in class com.liferay.faces.bridge.RequestAttributeInspectorFactory
Returns a new instance of RequestAttributeInspector.
getRequestAttributeInspectorInstance(PortletRequest, PortletConfig, BridgeConfig) - Static method in class com.liferay.faces.bridge.RequestAttributeInspectorFactory
Returns a new instance of RequestAttributeInspector from the RequestAttributeInspectorFactory found by the BridgeFactoryFinder.
getResourceRequest(ResourceRequest, ResourceResponse, PortletConfig, BridgeConfig) - Method in class com.liferay.faces.bridge.filter.BridgePortletRequestFactory
Returns a new instance of ResourceRequest.
getResourceRequestInstance(ResourceRequest, ResourceResponse, PortletConfig, BridgeConfig) - Static method in class com.liferay.faces.bridge.filter.BridgePortletRequestFactory
Returns a new instance of ResourceRequest from the BridgePortletRequestFactory found by the BridgeFactoryFinder.
getResourceResponse(ResourceRequest, ResourceResponse, PortletConfig, BridgeConfig) - Method in class com.liferay.faces.bridge.filter.BridgePortletResponseFactory
Returns a new instance of ResourceResponse.
getResourceResponseInstance(ResourceRequest, ResourceResponse, PortletConfig, BridgeConfig) - Static method in class com.liferay.faces.bridge.filter.BridgePortletResponseFactory
Returns a new instance of ResourceResponse from the BridgePortletResponseFactory found by the BridgeFactoryFinder.
getResponseCharacterSetEncoding(PortletRequest) - Method in class javax.portlet.faces.GenericFacesPortlet
Deprecated.
This method is no longer used or called by the GenericFacesPortlet but retained in case a subclass has called it.
getResponseContentType(PortletRequest) - Method in class javax.portlet.faces.GenericFacesPortlet
Deprecated.
This method is no longer used or called by the GenericFacesPortlet but retained in case a subclass has called it.
getSecure() - Method in class com.liferay.faces.portlet.component.baseurl.BaseURLBase
secure attribute description:
getSize() - Method in interface com.liferay.faces.bridge.model.UploadedFile
 
getStatus() - Method in interface com.liferay.faces.bridge.model.UploadedFile
 
getStyleClass() - Method in class com.liferay.faces.bridge.component.inputfile.InputFile
 
getUploadedFile() - Method in class com.liferay.faces.bridge.event.FileUploadEvent
 
getValue() - Method in class com.liferay.faces.portlet.component.param.ParamBase
value attribute description:
getValue() - Method in class com.liferay.faces.portlet.component.property.PropertyBase
value attribute description:
getValue() - Method in interface javax.portlet.faces.preference.Preference
Returns the first String value associated with this preference.
getValues() - Method in interface javax.portlet.faces.preference.Preference
Returns a List of values associated with this preference.
getVar() - Method in class com.liferay.faces.portlet.component.baseurl.BaseURLBase
var attribute description:
getVar() - Method in class com.liferay.faces.portlet.component.namespace.NamespaceBase
var attribute description:
getViewId() - Method in interface com.liferay.faces.bridge.BridgeURL
If the URL targets a Faces view, then returns the viewId.
getViewId() - Method in class com.liferay.faces.bridge.BridgeURLWrapper
 
getViewIdRenderParameterName() - Method in interface com.liferay.faces.bridge.BridgeConfig
Returns the parameter name used for storing the value of the target viewId in a RenderRequest.
getViewIdRenderParameterName() - Method in class com.liferay.faces.bridge.BridgeConfigWrapper
 
getViewIdResourceParameterName() - Method in interface com.liferay.faces.bridge.BridgeConfig
Returns the parameter name used for storing the value of the target viewId in a ResourceRequest.
getViewIdResourceParameterName() - Method in class com.liferay.faces.bridge.BridgeConfigWrapper
 
getWindowState() - Method in class com.liferay.faces.portlet.component.portleturl.PortletURLBase
windowState attribute description:
getWrapped() - Method in class com.liferay.faces.bridge.BridgeConfigFactory
Returns the wrapped factory instance if this factory decorates another.
getWrapped() - Method in class com.liferay.faces.bridge.BridgeConfigWrapper
 
getWrapped() - Method in class com.liferay.faces.bridge.BridgeEventHandlerFactory
Returns the wrapped factory instance if this factory decorates another.
getWrapped() - Method in class com.liferay.faces.bridge.BridgeEventHandlerWrapper
 
getWrapped() - Method in class com.liferay.faces.bridge.BridgePublicRenderParameterHandlerFactory
Returns the wrapped factory instance if this factory decorates another.
getWrapped() - Method in class com.liferay.faces.bridge.BridgePublicRenderParameterHandlerWrapper
 
getWrapped() - Method in class com.liferay.faces.bridge.BridgeURLFactory
Returns the wrapped factory instance if this factory decorates another.
getWrapped() - Method in class com.liferay.faces.bridge.BridgeURLWrapper
 
getWrapped() - Method in class com.liferay.faces.bridge.context.HeadResponseWriterFactory
Returns the wrapped factory instance if this factory decorates another.
getWrapped() - Method in class com.liferay.faces.bridge.event.EventPayloadWrapper
 
getWrapped() - Method in class com.liferay.faces.bridge.filter.BridgePortletConfigFactory
Returns the wrapped factory instance if this factory decorates another.
getWrapped() - Method in class com.liferay.faces.bridge.filter.BridgePortletContextFactory
Deprecated.
Returns the wrapped factory instance if this factory decorates another.
getWrapped() - Method in class com.liferay.faces.bridge.filter.BridgePortletRequestFactory
Returns the wrapped factory instance if this factory decorates another.
getWrapped() - Method in class com.liferay.faces.bridge.filter.BridgePortletResponseFactory
Returns the wrapped factory instance if this factory decorates another.
getWrapped() - Method in class com.liferay.faces.bridge.RequestAttributeInspectorFactory
Returns the wrapped factory instance if this factory decorates another.
getWrapped() - Method in class com.liferay.faces.bridge.RequestAttributeInspectorWrapper
 

H

handleEvent(FacesContext, Event) - Method in class com.liferay.faces.bridge.BridgeEventHandlerWrapper
 
handleEvent(FacesContext, Event) - Method in interface javax.portlet.faces.BridgeEventHandler
Called by the bridge when it needs to process a portlet event.
HeadResponseWriterFactory - Class in com.liferay.faces.bridge.context
 
HeadResponseWriterFactory() - Constructor for class com.liferay.faces.bridge.context.HeadResponseWriterFactory
 

I

IN_PROTOCOL_RESOURCE_LINK - Static variable in interface javax.portlet.faces.Bridge
Special token parameter in the URL passed to the bridge's implementation of ExternalContext.encodeResourceURL(String) that it recognizes as an indication that this resource should be handled in-protocol.
init(PortletConfig) - Method in interface javax.portlet.faces.Bridge
Called by the portlet.
init(PortletConfig) - Method in class javax.portlet.faces.GenericFacesPortlet
Initializes the GenericFacesPortlet according to the specified portlet configuration.
INITIALIZE_NAMESPACED_CONTEXT_ATTRIBUTES - Static variable in class javax.portlet.faces.GenericFacesPortlet
Portlet init-param that determines whether or not the GenericFacesPortlet.init(PortletConfig) method sets PortletContext attributes from PortletConfig init-param values, such that they are namespaced with the portlet name.
InputFile - Class in com.liferay.faces.bridge.component.inputfile
 
InputFile() - Constructor for class com.liferay.faces.bridge.component.inputfile.InputFile
 
InputFileBase - Class in com.liferay.faces.bridge.component.inputfile
 
InputFileBase() - Constructor for class com.liferay.faces.bridge.component.inputfile.InputFileBase
 
InputFileBase.InputFilePropertyKeys - Enum in com.liferay.faces.bridge.component.inputfile
 
IS_POSTBACK_ATTRIBUTE - Static variable in interface javax.portlet.faces.Bridge
Portlet request attribute set by the bridge when processing a Faces request that signals this request is a Faces postback.
isAppropriateListener(FacesListener) - Method in class com.liferay.faces.bridge.event.FileUploadEvent
 
isAuto() - Method in class com.liferay.faces.bridge.component.inputfile.InputFileBase
auto attribute description:
isAutoDispatchEvents() - Method in class javax.portlet.faces.GenericFacesPortlet
Returns the value of the portlet initialization parameter javax.portlet.faces.autoDispatchEvents if non-null or true, otherwise.
isCopyCurrentRenderParameters() - Method in class com.liferay.faces.portlet.component.portleturl.PortletURLBase
copyCurrentRenderParameters attribute description:
isEscapeXml() - Method in class com.liferay.faces.portlet.component.baseurl.BaseURLBase
escapeXml attribute description:
isExcludedByAnnotation(String, Object) - Method in interface com.liferay.faces.bridge.RequestAttributeInspector
Determines whether or not a request attribute is to be excluded from the bridge request scope because the specified value is an instance of a class annotated with ExcludeFromManagedRequestScope.
isExcludedByAnnotation(String, Object) - Method in class com.liferay.faces.bridge.RequestAttributeInspectorWrapper
 
isExcludedByConfig(String, Object) - Method in interface com.liferay.faces.bridge.RequestAttributeInspector
Determines whether or not a request attribute is to be excluded from the bridge request scope because the specified name appears in the bridge:excluded-attributes element within the faces-config.xml descriptor.
isExcludedByConfig(String, Object) - Method in class com.liferay.faces.bridge.RequestAttributeInspectorWrapper
 
isExcludedByPreExisting(String, Object) - Method in interface com.liferay.faces.bridge.RequestAttributeInspector
Determines whether or not a request attribute is to be excluded from the bridge request scope because the specified name matches the name of a request attribute that existed before the bridge acquired the FacesContext.
isExcludedByPreExisting(String, Object) - Method in class com.liferay.faces.bridge.RequestAttributeInspectorWrapper
 
isExcludedByType(String, Object) - Method in interface com.liferay.faces.bridge.RequestAttributeInspector
Determines whether or not a request attribute is to be excluded from the bridge request scope because the specified value is an instance of a particular class such as those listed in Section 5.1.2 of the Bridge Specification.
isExcludedByType(String, Object) - Method in class com.liferay.faces.bridge.RequestAttributeInspectorWrapper
 
isPortletRequest() - Static method in class javax.portlet.faces.BridgeUtil
Indicates whether the current request is executing in the portlet container.
isPortletRequest(FacesContext) - Static method in class javax.portlet.faces.BridgeUtil
Indicates whether the current request is executing in the portlet container.
isPreserveActionParameters() - Method in class javax.portlet.faces.GenericFacesPortlet
Deprecated.
Call ExternalContext.getInitParameter(String) with parameter "javax.portlet.faces.preserveActionParams" instead.

Returns a boolean indicating whether or not the bridge should preserve all the action parameters in the subsequent renders that occur in the same scope. This default implementation reads the values from the portlet init-param javax.portlet.faces.preserveActionParams. If not present, false is returned.

Note that this method will only be called by GenericFacesPortlet.init(PortletConfig) if the GenericFacesPortlet.INITIALIZE_NAMESPACED_CONTEXT_ATTRIBUTES init-param is true in WEB-INF/portlet.xml.

isReadOnly() - Method in interface javax.portlet.faces.preference.Preference
Returns true, if the value of this preference cannot be modified by the user.
isRedirect() - Method in class com.liferay.faces.bridge.event.EventPayloadWrapper
 

J

javax.portlet.faces - package javax.portlet.faces
 
javax.portlet.faces.annotation - package javax.portlet.faces.annotation
 
javax.portlet.faces.component - package javax.portlet.faces.component
 
javax.portlet.faces.event - package javax.portlet.faces.event
 
javax.portlet.faces.preference - package javax.portlet.faces.preference
 

L

LIFECYCLE_ID - Static variable in interface javax.portlet.faces.Bridge
Context initialization parameter that defines the lifecycle ID used to identify the Faces Lifecycle used for this application.

M

MAX_MANAGED_REQUEST_SCOPES - Static variable in interface javax.portlet.faces.Bridge
Context initialization parameter that specifies the maximum number of bridge request scopes to be preserved across all uses within this application.

N

Namespace - Class in com.liferay.faces.portlet.component.namespace
 
Namespace() - Constructor for class com.liferay.faces.portlet.component.namespace.Namespace
 
NamespaceBase - Class in com.liferay.faces.portlet.component.namespace
 
NamespaceBase() - Constructor for class com.liferay.faces.portlet.component.namespace.NamespaceBase
 
NamespaceBase.NamespacePropertyKeys - Enum in com.liferay.faces.portlet.component.namespace
 
NONFACES_TARGET_PATH_PARAMETER - Static variable in interface javax.portlet.faces.Bridge
Name of the render parameter set by the bridge when it encodes a navigation link to a non-Faces target.

P

Param - Class in com.liferay.faces.portlet.component.param
 
Param() - Constructor for class com.liferay.faces.portlet.component.param.Param
 
ParamBase - Class in com.liferay.faces.portlet.component.param
 
ParamBase() - Constructor for class com.liferay.faces.portlet.component.param.ParamBase
 
ParamBase.ParamPropertyKeys - Enum in com.liferay.faces.portlet.component.param
 
PORTLET_LIFECYCLE_PHASE - Static variable in interface javax.portlet.faces.Bridge
Portlet request attribute set by the bridge prior to creating/acquiring a FacesContext.
PORTLET_MODE_PARAMETER - Static variable in interface javax.portlet.faces.Bridge
Special token parameter in the URL passed to the bridge's implementation of ExternalContext.encodeActionURL(String) that it recognizes as an indication that this action should encode a portlet mode change to the one indicated by the parameter's value.
PORTLET_NAMESPACED_RESPONSE_PROPERTY - Static variable in interface javax.portlet.faces.Bridge
Name of the portlet response property set by the bridge when it recognizes that the view has been rendered using a NamingContainer that ensures all generated ids are namespaced using the consumer provided unique portlet id.
PORTLET_SECURE_PARAMETER - Static variable in interface javax.portlet.faces.Bridge
Special token parameter in the URL passed to bridge's implementation of ExternalContext.encodeActionURL(String) that it recognizes as an indication that this action should encode a security level change to the one indicated by the parameter's value.
PORTLET_WINDOWSTATE_PARAMETER - Static variable in interface javax.portlet.faces.Bridge
Special token parameter in the URL passed to the bridge's implementation of ExternalContext.encodeActionURL(String) that it recognizes as an indication that this action should encode a window state change to the one indicated by the parameter's value.
PortletNamingContainer - Annotation Type in javax.portlet.faces.annotation
This annotation is applied to the Bridge API PortletNamingContainerUIViewRoot and can be applied to others if necessary.
PortletNamingContainerUIViewRoot - Class in javax.portlet.faces.component
This class satisfies namespacing requirements of Section 6.6 of the specification.
PortletNamingContainerUIViewRoot() - Constructor for class javax.portlet.faces.component.PortletNamingContainerUIViewRoot
 
PortletURL - Class in com.liferay.faces.portlet.component.portleturl
 
PortletURL() - Constructor for class com.liferay.faces.portlet.component.portleturl.PortletURL
 
PortletURLBase - Class in com.liferay.faces.portlet.component.portleturl
 
PortletURLBase() - Constructor for class com.liferay.faces.portlet.component.portleturl.PortletURLBase
 
PortletURLBase.PortletURLPropertyKeys - Enum in com.liferay.faces.portlet.component.portleturl
 
POST_REDIRECT_GET_SUPPORT - Static variable in class com.liferay.faces.bridge.context.BridgePortalContext
Property indicating if the portal application supports/implements the POST-REDIRECT-GET design pattern, meaning that the PortletRequest.ACTION_PHASE originates from an HTTP POST request, and the PortletRequest.RENDER_PHASE is caused by a subsequent HTTP GET request.
Preference - Interface in javax.portlet.faces.preference
The Preference interface allows one to access each value from PortletPreferences as a discrete object.
PRESERVE_ACTION_PARAMS - Static variable in interface javax.portlet.faces.Bridge
Deprecated.
Call ExternalContext.getInitParameter(String) with parameter value "javax.portlet.faces.preserveActionParams" instead.

Portlet context attribute that a portlet can set prior to calling Bridge.init(PortletConfig) to configure the bridge to preserve action parameters received by this portlet along with bridge's request scope so that they may be restored and acessed in subsequent renders. If true, the action parameters are preserved. If false, they are not preserved. The bridge default is false.
As this attribute is scoped to a specific portlet in an application-wide context the attribute name must be include the portlet name as follows:

"javax.portlet.faces." + portletContext.getPortletName() + ".preserveActionParams"
processAction(ActionRequest, ActionResponse) - Method in class javax.portlet.faces.GenericFacesPortlet
processEvent(EventRequest, EventResponse) - Method in class javax.portlet.faces.GenericFacesPortlet
processListener(FacesListener) - Method in class com.liferay.faces.bridge.event.FileUploadEvent
 
processUpdates(FacesContext) - Method in class com.liferay.faces.bridge.BridgePublicRenderParameterHandlerWrapper
 
processUpdates(FacesContext) - Method in interface javax.portlet.faces.BridgePublicRenderParameterHandler
This method is called after the bridge has pushed public render parameter values into the model, which occurs after the RESTORE_VIEW phase of the JSF lifecycle.
Property - Class in com.liferay.faces.portlet.component.property
 
Property() - Constructor for class com.liferay.faces.portlet.component.property.Property
 
PropertyBase - Class in com.liferay.faces.portlet.component.property
 
PropertyBase() - Constructor for class com.liferay.faces.portlet.component.property.PropertyBase
 
PropertyBase.PropertyPropertyKeys - Enum in com.liferay.faces.portlet.component.property
 

R

releaseFactories(PortletContext) - Method in class com.liferay.faces.bridge.BridgeFactoryFinder
Releases all of the factories that are associated with the specified portlet context.
removeParameter(String) - Method in interface com.liferay.faces.bridge.BridgeURL
Removes the entry of the underlying BridgeURL.getParameterMap() according to the specified name.
removeParameter(String) - Method in class com.liferay.faces.bridge.BridgeURLWrapper
 
RENDERER_TYPE - Static variable in class com.liferay.faces.bridge.component.inputfile.InputFileBase
 
RENDERER_TYPE - Static variable in class com.liferay.faces.portlet.component.actionurl.ActionURLBase
 
RENDERER_TYPE - Static variable in class com.liferay.faces.portlet.component.baseurl.BaseURLBase
 
RENDERER_TYPE - Static variable in class com.liferay.faces.portlet.component.namespace.NamespaceBase
 
RENDERER_TYPE - Static variable in class com.liferay.faces.portlet.component.portleturl.PortletURLBase
 
RENDERER_TYPE - Static variable in class com.liferay.faces.portlet.component.renderurl.RenderURLBase
 
RENDERER_TYPE - Static variable in class com.liferay.faces.portlet.component.resourceurl.ResourceURLBase
 
RenderURL - Class in com.liferay.faces.portlet.component.renderurl
 
RenderURL() - Constructor for class com.liferay.faces.portlet.component.renderurl.RenderURL
 
RenderURLBase - Class in com.liferay.faces.portlet.component.renderurl
 
RenderURLBase() - Constructor for class com.liferay.faces.portlet.component.renderurl.RenderURLBase
 
RequestAttributeInspector - Interface in com.liferay.faces.bridge
 
RequestAttributeInspectorFactory - Class in com.liferay.faces.bridge
 
RequestAttributeInspectorFactory() - Constructor for class com.liferay.faces.bridge.RequestAttributeInspectorFactory
 
RequestAttributeInspectorWrapper - Class in com.liferay.faces.bridge
 
RequestAttributeInspectorWrapper() - Constructor for class com.liferay.faces.bridge.RequestAttributeInspectorWrapper
 
reset() - Method in interface javax.portlet.faces.preference.Preference
Resets or removes the value(s) of this preference.
ResourceURL - Class in com.liferay.faces.portlet.component.resourceurl
 
ResourceURL() - Constructor for class com.liferay.faces.portlet.component.resourceurl.ResourceURL
 
ResourceURLBase - Class in com.liferay.faces.portlet.component.resourceurl
 
ResourceURLBase() - Constructor for class com.liferay.faces.portlet.component.resourceurl.ResourceURLBase
 
ResourceURLBase.ResourceURLPropertyKeys - Enum in com.liferay.faces.portlet.component.resourceurl
 

S

SAVESTATE_FIELD_MARKER - Static variable in interface javax.portlet.faces.Bridge
Context initialization parameter that defines the SAVESTATE_FIELD_MARKER in use in the given deployment.
serveResource(ResourceRequest, ResourceResponse) - Method in class javax.portlet.faces.GenericFacesPortlet
SET_HTTP_STATUS_CODE_SUPPORT - Static variable in class com.liferay.faces.bridge.context.BridgePortalContext
Property indicating if the portal application supports the standard mechanism of setting the ResourceResponse.HTTP_STATUS_CODE property on the ResourceResponse.
SET_RESOURCE_RESPONSE_BUFFER_SIZE_SUPPORT - Static variable in class com.liferay.faces.bridge.context.BridgePortalContext
Property indicating if the portal application supports setting the buffer size on its ResourceResponse implementation.
setAuto(boolean) - Method in class com.liferay.faces.bridge.component.inputfile.InputFileBase
auto attribute description:
setCacheability(String) - Method in class com.liferay.faces.portlet.component.resourceurl.ResourceURLBase
cacheability attribute description:
setCopyCurrentRenderParameters(boolean) - Method in class com.liferay.faces.portlet.component.portleturl.PortletURLBase
copyCurrentRenderParameters attribute description:
setEscapeXml(boolean) - Method in class com.liferay.faces.portlet.component.baseurl.BaseURLBase
escapeXml attribute description:
setFileUploadListener(MethodExpression) - Method in class com.liferay.faces.bridge.component.inputfile.InputFileBase
fileUploadListener attribute description:
setFromAction(String) - Method in class javax.portlet.faces.event.EventNavigationResult
Sets the value that corresponds to the <from-action> element of a navigation-rule.
setId(String) - Method in class com.liferay.faces.portlet.component.resourceurl.ResourceURLBase
id attribute description:
setMultiple(String) - Method in class com.liferay.faces.bridge.component.inputfile.InputFileBase
multiple attribute description:
setName(String) - Method in class com.liferay.faces.portlet.component.actionurl.ActionURLBase
name attribute description:
setName(String) - Method in class com.liferay.faces.portlet.component.param.ParamBase
name attribute description:
setName(String) - Method in class com.liferay.faces.portlet.component.property.PropertyBase
name attribute description:
setName(String) - Method in interface javax.portlet.faces.preference.Preference
Sets the name of this preference.
setOutcome(String) - Method in class javax.portlet.faces.event.EventNavigationResult
Sets the value that corresponds to the <outcome> element of a navigation-rule.
setParameter(String, String) - Method in interface com.liferay.faces.bridge.BridgeURL
Sets the value of the underlying BridgeURL.getParameterMap() according to the specified name.
setParameter(String, String[]) - Method in interface com.liferay.faces.bridge.BridgeURL
Sets the value of the underlying BridgeURL.getParameterMap() according to the specified name.
setParameter(String, String) - Method in class com.liferay.faces.bridge.BridgeURLWrapper
 
setParameter(String, String[]) - Method in class com.liferay.faces.bridge.BridgeURLWrapper
 
setPortletMode(String) - Method in class com.liferay.faces.portlet.component.portleturl.PortletURLBase
portletMode attribute description:
setSecure(Boolean) - Method in class com.liferay.faces.portlet.component.baseurl.BaseURLBase
secure attribute description:
setValue(String) - Method in class com.liferay.faces.portlet.component.param.ParamBase
value attribute description:
setValue(String) - Method in class com.liferay.faces.portlet.component.property.PropertyBase
value attribute description:
setValue(String) - Method in interface javax.portlet.faces.preference.Preference
Associates the specified String value with this preference.
setValues(String[]) - Method in interface javax.portlet.faces.preference.Preference
Associates the specified String array value with this preference.
setVar(String) - Method in class com.liferay.faces.portlet.component.baseurl.BaseURLBase
var attribute description:
setVar(String) - Method in class com.liferay.faces.portlet.component.namespace.NamespaceBase
var attribute description:
setWindowState(String) - Method in class com.liferay.faces.portlet.component.portleturl.PortletURLBase
windowState attribute description:
STRICT_NAMESPACED_PARAMETERS_SUPPORT - Static variable in class com.liferay.faces.bridge.context.BridgePortalContext
Property indicating if the portal application requires parameters to be namespaced.

T

toString() - Method in interface com.liferay.faces.bridge.BridgeURL
Returns a string-based representation of the URL.
toString() - Method in class com.liferay.faces.bridge.BridgeURLWrapper
 

U

UploadedFile - Interface in com.liferay.faces.bridge.model
 
UploadedFile.Status - Enum in com.liferay.faces.bridge.model
 

V

valueOf(String) - Static method in enum com.liferay.faces.bridge.component.inputfile.InputFileBase.InputFilePropertyKeys
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.liferay.faces.bridge.model.UploadedFile.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.liferay.faces.portlet.component.actionurl.ActionURLBase.ActionURLPropertyKeys
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.liferay.faces.portlet.component.baseurl.BaseURLBase.BaseURLPropertyKeys
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.liferay.faces.portlet.component.namespace.NamespaceBase.NamespacePropertyKeys
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.liferay.faces.portlet.component.param.ParamBase.ParamPropertyKeys
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.liferay.faces.portlet.component.portleturl.PortletURLBase.PortletURLPropertyKeys
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.liferay.faces.portlet.component.property.PropertyBase.PropertyPropertyKeys
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.liferay.faces.portlet.component.resourceurl.ResourceURLBase.ResourceURLPropertyKeys
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum javax.portlet.faces.Bridge.PortletPhase
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.liferay.faces.bridge.component.inputfile.InputFileBase.InputFilePropertyKeys
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.liferay.faces.bridge.model.UploadedFile.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.liferay.faces.portlet.component.actionurl.ActionURLBase.ActionURLPropertyKeys
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.liferay.faces.portlet.component.baseurl.BaseURLBase.BaseURLPropertyKeys
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.liferay.faces.portlet.component.namespace.NamespaceBase.NamespacePropertyKeys
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.liferay.faces.portlet.component.param.ParamBase.ParamPropertyKeys
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.liferay.faces.portlet.component.portleturl.PortletURLBase.PortletURLPropertyKeys
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.liferay.faces.portlet.component.property.PropertyBase.PropertyPropertyKeys
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.liferay.faces.portlet.component.resourceurl.ResourceURLBase.ResourceURLPropertyKeys
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum javax.portlet.faces.Bridge.PortletPhase
Returns an array containing the constants of this enum type, in the order they are declared.
VIEW_ID - Static variable in interface javax.portlet.faces.Bridge
Portlet request attribute that a portlet may set prior to calling the bridge's Bridge.doFacesRequest(RenderRequest, RenderResponse) method.
VIEW_LINK - Static variable in interface javax.portlet.faces.Bridge
Special token parameter in the URL passed to the bridge's implementation of ExternalContext.encodeResourceURL(String) that it recognizes as an indication that this URL refers to Faces view (navigation) and hence should be encoded as a portlet ActionURL rather then a portlet ResourceURL.
VIEW_PATH - Static variable in interface javax.portlet.faces.Bridge
Portlet request attribute that a portlet may set prior to calling the bridge's Bridge.doFacesRequest(RenderRequest, RenderResponse) method.
VIEWID_HISTORY - Static variable in interface javax.portlet.faces.Bridge
Portlet session attribute set by the bridge to hold the last viewId accessed in a given mode.

W

write(String) - Method in interface com.liferay.faces.bridge.model.UploadedFile
 
A B C D E F G H I J L M N P R S T U V W 
Skip navigation links

Copyright © 2018 Liferay, Inc. All rights reserved.