public abstract class PortletHelperWrapper extends Object implements PortletHelper, javax.faces.FacesWrapper<PortletHelper>
Constructor and Description |
---|
PortletHelperWrapper() |
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)
|
public abstract PortletHelper getWrapped()
getWrapped
in interface javax.faces.FacesWrapper<PortletHelper>
public javax.portlet.PortletURL createActionURL()
PortletHelper
createActionURL
in interface PortletHelper
public javax.portlet.PortletURL createRenderURL()
PortletHelper
createRenderURL
in interface PortletHelper
public javax.portlet.ActionResponse getActionResponse()
PortletHelper
javax.portlet.ActionResponse
object associated with the current JSF FacesContext.getActionResponse
in interface PortletHelper
public javax.portlet.PortalContext getPortalContext()
PortletHelper
javax.portlet.PortalContext
object associated with the current JSF FacesContext.getPortalContext
in interface PortletHelper
public javax.portlet.PortletConfig getPortletConfig()
PortletHelper
javax.portlet.PortletConfig
object associated with the current JSF FacesContext.getPortletConfig
in interface PortletHelper
public javax.portlet.PortletContext getPortletContext()
PortletHelper
javax.portlet.PortletContext
object associated with the current JSF FacesContext.getPortletContext
in interface PortletHelper
public String getPortletContextName()
PortletHelper
getPortletContextName
in interface PortletHelper
public String getPortletName()
PortletHelper
getPortletName
in interface PortletHelper
public Object getPortletPreference(String preferenceName, Object defaultValue)
PortletHelper
javax.portlet.PortletPreferences
object associated with the current JSF FacesContext.getPortletPreference
in interface PortletHelper
public boolean getPortletPreferenceAsBool(String preferenceName, boolean defaultValue)
PortletHelper
getPortletPreferenceAsBool
in interface PortletHelper
public int getPortletPreferenceAsInt(String preferenceName, int defaultValue)
PortletHelper
getPortletPreferenceAsInt
in interface PortletHelper
public short getPortletPreferenceAsShort(String preferenceName, short defaultValue)
PortletHelper
getPortletPreferenceAsShort
in interface PortletHelper
public String getPortletPreferenceAsString(String preferenceName, String defaultValue)
PortletHelper
getPortletPreferenceAsString
in interface PortletHelper
public javax.portlet.PortletPreferences getPortletPreferences()
PortletHelper
javax.portlet.PortletPreferences
object associated with the current JSF FacesContext.getPortletPreferences
in interface PortletHelper
public javax.portlet.RenderRequest getPortletRenderRequest()
PortletHelper
javax.portlet.RenderRequest
object associated with the current JSF FacesContext.getPortletRenderRequest
in interface PortletHelper
public javax.portlet.RenderResponse getPortletRenderResponse()
PortletHelper
javax.portlet.RenderResponse
object associated with the current JSF FacesContext.getPortletRenderResponse
in interface PortletHelper
public javax.portlet.PortletRequest getPortletRequest()
PortletHelper
javax.portlet.PortletRequest
object associated with the current JSF FacesContext.getPortletRequest
in interface PortletHelper
public javax.portlet.PortletResponse getPortletResponse()
PortletHelper
javax.portlet.PortletResponse
object associated with the current JSF FacesContext.getPortletResponse
in interface PortletHelper
public javax.portlet.PortletSession getPortletSession()
PortletHelper
javax.portlet.PortletSession
object associated with the current JSF FacesContext.getPortletSession
in interface PortletHelper
public String getRemoteUser()
PortletHelper
getRemoteUser
in interface PortletHelper
public Object getSessionSharedAttribute(String name)
PortletHelper
getSessionSharedAttribute
in interface PortletHelper
public javax.portlet.WindowState getWindowState()
PortletHelper
getWindowState
in interface PortletHelper
public boolean isPortletEnvironment()
PortletHelper
isPortletEnvironment
in interface PortletHelper
public boolean isUserInRole(String roleName)
PortletHelper
isUserInRole
in interface PortletHelper
public boolean isWindowMaximized()
PortletHelper
isWindowMaximized
in interface PortletHelper
public boolean isWindowNormal()
PortletHelper
isWindowNormal
in interface PortletHelper
public void setPortletMode(javax.portlet.PortletMode portletMode)
PortletHelper
setPortletMode
in interface PortletHelper
public void setSessionSharedAttribute(String name, Object value)
PortletHelper
setSessionSharedAttribute
in interface PortletHelper
public void setWindowState(javax.portlet.WindowState windowState)
PortletHelper
setWindowState
in interface PortletHelper
public void setWindowStateToMaximized()
PortletHelper
setWindowStateToMaximized
in interface PortletHelper
public void setWindowStateToNormal()
PortletHelper
setWindowStateToNormal
in interface PortletHelper
Copyright © 2019 Liferay, Inc.. All rights reserved.