PortletHelperWrapper (Liferay Faces Portal 5.0.0 API)

java.lang.Object
- com.liferay.faces.portal.context.PortletHelperWrapper

All Implemented Interfaces:: PortletHelper, javax.faces.FacesWrapper<PortletHelper>

public abstract class PortletHelperWrapper
extends Object
implements PortletHelper, javax.faces.FacesWrapper<PortletHelper>

Author:: Neil Griffin

Constructor Summary

Constructors
Constructor and Description

PortletHelperWrapper()

Constructors
Constructor and Description
`PortletHelperWrapper()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`javax.portlet.PortletURL`	`createActionURL()` Retrieves a render URL for the current facesContext.
`javax.portlet.PortletURL`	`createRenderURL()` Retrieves a render URL for the current facesContext.
`javax.portlet.ActionResponse`	`getActionResponse()` Retrieves the `javax.portlet.ActionResponse` object associated with the current JSF FacesContext.
`javax.portlet.PortalContext`	`getPortalContext()` Retrieves the `javax.portlet.PortalContext` object associated with the current JSF FacesContext.
`javax.portlet.PortletConfig`	`getPortletConfig()` Retrieves the `javax.portlet.PortletConfig` object associated with the current JSF FacesContext.
`javax.portlet.PortletContext`	`getPortletContext()` Retrieves the `javax.portlet.PortletContext` object associated with the current JSF FacesContext.
`String`	`getPortletContextName()` Retrieves the name of the portlet associated with the current JSF FacesContext (usually, its the name of the portlet .war)
`String`	`getPortletName()` Retrieves the name of the portlet associated with the current JSF FacesContext (as defined in portlet.xml's <portlet-name> tag).
`Object`	`getPortletPreference(String preferenceName, Object defaultValue)` Returns String representation of the value of the portlet preference associated with the specified name in from the `javax.portlet.PortletPreferences` object associated with the current JSF FacesContext.
`boolean`	`getPortletPreferenceAsBool(String preferenceName, boolean defaultValue)` Returns boolean representation of the value of the portlet preference associated with the specified name in from the PortletPreferenceMap object associated with the current JSF FacesContext.
`int`	`getPortletPreferenceAsInt(String preferenceName, int defaultValue)` Returns integer representation of the value of the portlet preference associated with the specified name in from the PortletPreferenceMap object associated with the current JSF FacesContext.
`short`	`getPortletPreferenceAsShort(String preferenceName, short defaultValue)` Returns short representation of the value of the portlet preference associated with the specified name in from the PortletPreferenceMap object associated with the current JSF FacesContext.
`String`	`getPortletPreferenceAsString(String preferenceName, String defaultValue)` Returns short representation of the value of the portlet preference associated with the specified name in from the PortletPreferenceMap object associated with the current JSF FacesContext.
`javax.portlet.PortletPreferences`	`getPortletPreferences()` Retrieves the `javax.portlet.PortletPreferences` object associated with the current JSF FacesContext.
`javax.portlet.RenderRequest`	`getPortletRenderRequest()` Retrieves the `javax.portlet.RenderRequest` object associated with the current JSF FacesContext.
`javax.portlet.RenderResponse`	`getPortletRenderResponse()` Retrieves the `javax.portlet.RenderResponse` object associated with the current JSF FacesContext.
`javax.portlet.PortletRequest`	`getPortletRequest()` Retrieves the `javax.portlet.PortletRequest` object associated with the current JSF FacesContext.
`javax.portlet.PortletResponse`	`getPortletResponse()` Retrieves the `javax.portlet.PortletResponse` object associated with the current JSF FacesContext.
`javax.portlet.PortletSession`	`getPortletSession()` Retrieves the `javax.portlet.PortletSession` object associated with the current JSF FacesContext.
`String`	`getRemoteUser()` Returns the user name/id of the user associated with the current JSF FacesContext
`Object`	`getSessionSharedAttribute(String name)` Returns the value of the session attribute associated with the specified name from PortletSession.APPLICATION_SCOPE
`javax.portlet.WindowState`	`getWindowState()` Returns the window state of the portlet associated with the current JSF FacesContext
`abstract PortletHelper`	`getWrapped()`
`boolean`	`isPortletEnvironment()` Returns TRUE if the underlying request/response is from a portlet environment.
`boolean`	`isUserInRole(String roleName)` Returns TRUE if the current user is associated with the specified role.
`boolean`	`isWindowMaximized()` Returns TRUE if the Window state of the current portlet is set to MAXIMIZED
`boolean`	`isWindowNormal()` Returns TRUE if the Window state of the current portlet is set to MAXIMIZED
`void`	`setPortletMode(javax.portlet.PortletMode portletMode)` Sets the portlet mode of the portlet associated with the current JSF FacesContext to the specified portlet mode.
`void`	`setSessionSharedAttribute(String name, Object value)` Sets the value of the a session attribute using the specified name and value within PortletSession.APPLICATION_SCOPE
`void`	`setWindowState(javax.portlet.WindowState windowState)` Sets the window state of the portlet associated with the current JSF FacesContext to the specified window state.
`void`	`setWindowStateToMaximized()` A short-cut method for calling setWindowState(WindowState.MAXIMIZED)
`void`	`setWindowStateToNormal()` A short-cut method for calling setWindowState(WindowState.NORMAL)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PortletHelperWrapper
```
public PortletHelperWrapper()
```
- Method Detail
  - getWrapped
```
public abstract PortletHelper getWrapped()
```
    Specified by:
    
    getWrapped in interface javax.faces.FacesWrapper<PortletHelper>
  - createActionURL
```
public javax.portlet.PortletURL createActionURL()
```
    Description copied from interface: PortletHelper
    
    Retrieves a render URL for the current facesContext.
    
    Specified by:
    
    createActionURL in interface PortletHelper
  - createRenderURL
```
public javax.portlet.PortletURL createRenderURL()
```
    Description copied from interface: PortletHelper
    
    Retrieves a render URL for the current facesContext.
    
    Specified by:
    
    createRenderURL in interface PortletHelper
  - getActionResponse
```
public javax.portlet.ActionResponse getActionResponse()
```
    Description copied from interface: PortletHelper
    
    Retrieves the javax.portlet.ActionResponse object associated with the current JSF FacesContext.
    
    Specified by:
    
    getActionResponse in interface PortletHelper
  - getPortalContext
```
public javax.portlet.PortalContext getPortalContext()
```
    Description copied from interface: PortletHelper
    
    Retrieves the javax.portlet.PortalContext object associated with the current JSF FacesContext.
    
    Specified by:
    
    getPortalContext in interface PortletHelper
  - getPortletConfig
```
public javax.portlet.PortletConfig getPortletConfig()
```
    Description copied from interface: PortletHelper
    
    Retrieves the javax.portlet.PortletConfig object associated with the current JSF FacesContext.
    
    Specified by:
    
    getPortletConfig in interface PortletHelper
  - getPortletContext
```
public javax.portlet.PortletContext getPortletContext()
```
    Description copied from interface: PortletHelper
    
    Retrieves the javax.portlet.PortletContext object associated with the current JSF FacesContext.
    
    Specified by:
    
    getPortletContext in interface PortletHelper
  - getPortletContextName
```
public String getPortletContextName()
```
    Description copied from interface: PortletHelper
    
    Retrieves the name of the portlet associated with the current JSF FacesContext (usually, its the name of the portlet .war)
    
    Specified by:
    
    getPortletContextName in interface PortletHelper
  - getPortletName
```
public String getPortletName()
```
    Description copied from interface: PortletHelper
    
    Retrieves the name of the portlet associated with the current JSF FacesContext (as defined in portlet.xml's <portlet-name> tag).
    
    Specified by:
    
    getPortletName in interface PortletHelper
  - getPortletPreference
```
public Object getPortletPreference(String preferenceName,
                                   Object defaultValue)
```
    Description copied from interface: PortletHelper
    
    Returns String representation of the value of the portlet preference associated with the specified name in from the javax.portlet.PortletPreferences object associated with the current JSF FacesContext.
    
    Specified by:
    
    getPortletPreference in interface PortletHelper
  - getPortletPreferenceAsBool
```
public boolean getPortletPreferenceAsBool(String preferenceName,
                                          boolean defaultValue)
```
    Description copied from interface: PortletHelper
    
    Returns boolean representation of the value of the portlet preference associated with the specified name in from the PortletPreferenceMap object associated with the current JSF FacesContext.
    
    Specified by:
    
    getPortletPreferenceAsBool in interface PortletHelper
  - getPortletPreferenceAsInt
```
public int getPortletPreferenceAsInt(String preferenceName,
                                     int defaultValue)
```
    Description copied from interface: PortletHelper
    
    Returns integer representation of the value of the portlet preference associated with the specified name in from the PortletPreferenceMap object associated with the current JSF FacesContext.
    
    Specified by:
    
    getPortletPreferenceAsInt in interface PortletHelper
  - getPortletPreferenceAsShort
```
public short getPortletPreferenceAsShort(String preferenceName,
                                         short defaultValue)
```
    Description copied from interface: PortletHelper
    
    Returns short representation of the value of the portlet preference associated with the specified name in from the PortletPreferenceMap object associated with the current JSF FacesContext.
    
    Specified by:
    
    getPortletPreferenceAsShort in interface PortletHelper
  - getPortletPreferenceAsString
```
public String getPortletPreferenceAsString(String preferenceName,
                                           String defaultValue)
```
    Description copied from interface: PortletHelper
    
    Returns short representation of the value of the portlet preference associated with the specified name in from the PortletPreferenceMap object associated with the current JSF FacesContext.
    
    Specified by:
    
    getPortletPreferenceAsString in interface PortletHelper
  - getPortletPreferences
```
public javax.portlet.PortletPreferences getPortletPreferences()
```
    Description copied from interface: PortletHelper
    
    Retrieves the javax.portlet.PortletPreferences object associated with the current JSF FacesContext.
    
    Specified by:
    
    getPortletPreferences in interface PortletHelper
  - getPortletRenderRequest
```
public javax.portlet.RenderRequest getPortletRenderRequest()
```
    Description copied from interface: PortletHelper
    
    Retrieves the javax.portlet.RenderRequest object associated with the current JSF FacesContext.
    
    Specified by:
    
    getPortletRenderRequest in interface PortletHelper
  - getPortletRenderResponse
```
public javax.portlet.RenderResponse getPortletRenderResponse()
```
    Description copied from interface: PortletHelper
    
    Retrieves the javax.portlet.RenderResponse object associated with the current JSF FacesContext.
    
    Specified by:
    
    getPortletRenderResponse in interface PortletHelper
  - getPortletRequest
```
public javax.portlet.PortletRequest getPortletRequest()
```
    Description copied from interface: PortletHelper
    
    Retrieves the javax.portlet.PortletRequest object associated with the current JSF FacesContext.
    
    Specified by:
    
    getPortletRequest in interface PortletHelper
  - getPortletResponse
```
public javax.portlet.PortletResponse getPortletResponse()
```
    Description copied from interface: PortletHelper
    
    Retrieves the javax.portlet.PortletResponse object associated with the current JSF FacesContext.
    
    Specified by:
    
    getPortletResponse in interface PortletHelper
  - getPortletSession
```
public javax.portlet.PortletSession getPortletSession()
```
    Description copied from interface: PortletHelper
    
    Retrieves the javax.portlet.PortletSession object associated with the current JSF FacesContext.
    
    Specified by:
    
    getPortletSession in interface PortletHelper
  - getRemoteUser
```
public String getRemoteUser()
```
    Description copied from interface: PortletHelper
    
    Returns the user name/id of the user associated with the current JSF FacesContext
    
    Specified by:
    
    getRemoteUser in interface PortletHelper
  - getSessionSharedAttribute
```
public Object getSessionSharedAttribute(String name)
```
    Description copied from interface: PortletHelper
    
    Returns the value of the session attribute associated with the specified name from PortletSession.APPLICATION_SCOPE
    
    Specified by:
    
    getSessionSharedAttribute in interface PortletHelper
  - getWindowState
```
public javax.portlet.WindowState getWindowState()
```
    Description copied from interface: PortletHelper
    
    Returns the window state of the portlet associated with the current JSF FacesContext
    
    Specified by:
    
    getWindowState in interface PortletHelper
  - isPortletEnvironment
```
public boolean isPortletEnvironment()
```
    Description copied from interface: PortletHelper
    
    Returns TRUE if the underlying request/response is from a portlet environment. Otherwise, must be running in a servlet environment.
    
    Specified by:
    
    isPortletEnvironment in interface PortletHelper
  - isUserInRole
```
public boolean isUserInRole(String roleName)
```
    Description copied from interface: PortletHelper
    
    Returns TRUE if the current user is associated with the specified role.
    
    Specified by:
    
    isUserInRole in interface PortletHelper
  - isWindowMaximized
```
public boolean isWindowMaximized()
```
    Description copied from interface: PortletHelper
    
    Returns TRUE if the Window state of the current portlet is set to MAXIMIZED
    
    Specified by:
    
    isWindowMaximized in interface PortletHelper
  - isWindowNormal
```
public boolean isWindowNormal()
```
    Description copied from interface: PortletHelper
    
    Returns TRUE if the Window state of the current portlet is set to MAXIMIZED
    
    Specified by:
    
    isWindowNormal in interface PortletHelper
  - setPortletMode
```
public void setPortletMode(javax.portlet.PortletMode portletMode)
```
    Description copied from interface: PortletHelper
    
    Sets the portlet mode of the portlet associated with the current JSF FacesContext to the specified portlet mode.
    
    Specified by:
    
    setPortletMode in interface PortletHelper
  - setSessionSharedAttribute
```
public void setSessionSharedAttribute(String name,
                                      Object value)
```
    Description copied from interface: PortletHelper
    
    Sets the value of the a session attribute using the specified name and value within PortletSession.APPLICATION_SCOPE
    
    Specified by:
    
    setSessionSharedAttribute in interface PortletHelper
  - setWindowState
```
public void setWindowState(javax.portlet.WindowState windowState)
```
    Description copied from interface: PortletHelper
    
    Sets the window state of the portlet associated with the current JSF FacesContext to the specified window state.
    
    Specified by:
    
    setWindowState in interface PortletHelper
  - setWindowStateToMaximized
```
public void setWindowStateToMaximized()
```
    Description copied from interface: PortletHelper
    
    A short-cut method for calling setWindowState(WindowState.MAXIMIZED)
    
    Specified by:
    
    setWindowStateToMaximized in interface PortletHelper
  - setWindowStateToNormal
```
public void setWindowStateToNormal()
```
    Description copied from interface: PortletHelper
    
    A short-cut method for calling setWindowState(WindowState.NORMAL)
    
    Specified by:
    
    setWindowStateToNormal in interface PortletHelper

Class PortletHelperWrapper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PortletHelperWrapper

Method Detail

getWrapped

createActionURL

createRenderURL

getActionResponse

getPortalContext

getPortletConfig

getPortletContext

getPortletContextName

getPortletName

getPortletPreference

getPortletPreferenceAsBool

getPortletPreferenceAsInt

getPortletPreferenceAsShort

getPortletPreferenceAsString

getPortletPreferences

getPortletRenderRequest

getPortletRenderResponse

getPortletRequest

getPortletResponse

getPortletSession

getRemoteUser

getSessionSharedAttribute

getWindowState

isPortletEnvironment

isUserInRole

isWindowMaximized

isWindowNormal

setPortletMode

setSessionSharedAttribute

setWindowState

setWindowStateToMaximized

setWindowStateToNormal