PresentationContext
This class represents a portal window component. All presentation-related attributes of a window component are available from instances of this class. Such instances are typically used during portal rendering via look and feel skeleton files (e.g. window.jsp).
Related Topics
WindowPresentationContext.getWindowPresentationContext(HttpServletRequest)
Object
ControlContext
PresentationContext
WindowPresentationContext
Serializable
PagePresentationContext
, PortletPresentationContext
Field Summary |
protected static final |
|
Fields from com.bea.netuix.servlets.controls. |
debug |
Constructor Summary |
Method Summary |
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public abstract |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public static |
|
public |
|
public boolean |
|
public boolean |
|
Methods from com.bea.netuix.servlets.controls. |
|
Methods from com.bea.netuix.servlets.controls. |
getContextFromRequest, getContextKey, getControl, getRequestKey, getUniqueId, removeContextFromRequest, setContextInRequest |
Methods from class java.lang. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static final String
CLASS_NAME
Constructor Detail |
Method Detail |
publicCapability
getCapability(Capability
capability)
throwsNullPointerException
Gets the capability for the Window, may be a state or a mode. This method can be used to
check if a Window (Book, Page or Portlet) supports a given Mode or State. If you are intersted in
the current or active Window Mode or Window State you should use getWindowMode()
and getWindowState
repectively.
Note: this method should be called after the init()
lifcycle,
because the buttons have net yet registered with the parent window.
Capability
to check for. NullPointerException
Related Topics
WindowCapabilities
com.bea.netuix.servlets.controls;.Capability
com.bea.netuix.servlets.controls.window.WindowMode;
com.bea.netuix.servlets.controls.window.WindowState;
public String
getContentPresentationClass()
Returns this window's content presentationClass attribute. Since window content areas do not have presentation
contexts, their presentationClass attribute can be accessed from their parent window. This attribute should only
affect the content area of the window.
Related Topics
getPresentationClass
public List
getContentPresentationContextChildren()
Returns a list of PresentationContext
children within this window's content area.
public String
getContentPresentationStyle()
Returns this window's content presentationStyle attribute. Since window content areas do not have presentation
contexts, their presentationStyle attribute can be accessed from their parent window. This attribute should only
affect the content area of the window.
Related Topics
getPresentationStyle
public String
getDefinitionId()
The definition id for the window. This value is only valid in portal streaming mode.
public String
getDefinitionLabel()
The definition label for the window. This will be valid in both portal streaming and non-streaming modes,
but may not necessarily be unique.
public String
getInstanceId()
Returns the instance id for the window. This value is only valid in portal streaming mode.
public abstract String
getLabel()
Returns a general label for the window. The precise semantic of the value depends on the subclass's
implementation, but generally returns the most specific label (between definition label and instance label)
available for the subtype.
public String
getOrientation()
Returns the orientation of the window's navigation/titlebar. Values are top (the default), left, right,
or bottom.
public PagePresentationContext
getParentPagePresentationContext()
If this window is a child of a page, that page's PagePresentationContext
is returned.
public WindowMode
getPreviousWindowMode()
Returns the previous mode of the window, which may be from the standard set or an extended mode. Standard modes
include (but are not limited to) view, edit, help, etc.
Related Topics
public ThemePresentationContext
getThemePresentationContext()
Returns a ThemePresentation context for this portlet, page or book if one has been applied.
public String
getTitle()
Returns the display title for the window, which may be localized if a proper localizable value can be resolved.
public TitlebarPresentationContext
getTitlebarPresentationContext()
Returns a TitlebarPresentation context for this portlet, page or book if one exists.
public WindowMode
getWindowMode()
Returns the current mode of the window, which may be from the standard set or an extended mode. Standard modes
include (but are not limited to) view, edit, help, etc.
Related Topics
public staticThis is a convenience method for returning a reference to the currentWindowPresentationContext
getWindowPresentationContext(HttpServletRequest
request)
WindowPresentationContext
.
Note this method will only work if called from within a portal (typically, from the window.jsp skeleton).
This method may return null if called when no appropriate context exists, but such a context should safely
exist when being fetched from the associated skeleton JSP during normal portal rendering.
public WindowState
getWindowState()
Returns the current state of the window, which may be from the following fixed set: normal, minimized, maximized.
Related Topics
public boolean isCapable(Capability
capability)
Returns true
if this control has the specified capability.
Related Topics
public boolean isPacked()Returns whether or not the window should be rendered such that it occupies a minimal space as required by its contents (packed), or tries to expand to the maximum size of its containing layout cell.