|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.bea.netuix.servlets.controls.ControlContext
com.bea.netuix.servlets.controls.PresentationContext
com.bea.netuix.servlets.controls.window.WindowPresentationContext
com.bea.netuix.servlets.controls.page.PagePresentationContext
public class PagePresentationContext
This class represents a portal page component. All presentation-related attributes of a page component are available from instances of this class. Such instances are typically used during portal rendering via look and feel skeleton files (e.g. page.jsp).
getPagePresentationContext(javax.servlet.http.HttpServletRequest)
, Serialized FormField Summary | |
---|---|
protected static String |
CLASS_NAME |
Method Summary | |
---|---|
String |
getActiveImage() Returns the webapp-qualified path to a fully skinned, classified, localized, and themed image to be displayed when this page is active. |
BookPresentationContext |
getBookPresentationContextRecursive(String definitionLabel) Returns a book, searching the entire tree recursively. |
String |
getInactiveImage() Returns the webapp-qualified path to a fully skinned, classified, localized, and themed image to be displayed when this page is inactive. |
String |
getLabel() Return the label for this page. |
static PagePresentationContext |
getPagePresentationContext(javax.servlet.http.HttpServletRequest request) This is a convenience method for returning a reference to the current PagePresentationContext . |
PagePresentationContext |
getPagePresentationContextRecursive(String definitionLabel) Returns a book or a page but traverse the entire tree; this will go inside books that are on pages too. |
BookPresentationContext |
getParentBookPresentationContext() Get the presentation context for the parent book. |
PortletPresentationContext |
getPortletPresentationContextRecursive(String instanceLabel) Returns the PortletPresentationContext matching the supplied instance label. |
PortletPresentationContext[] |
getPortletsPresentationContextRecursive(String definitionLabel) Returns an array of PortletPresentationContext s matching the supplied definition label. |
String |
getRolloverImage() Returns the webapp-qualified path to a fully skinned, classified, localized, and themed image to be displayed when this page is inactive. |
List |
getWindowPresentationContexts() Return the collection of child WindowPresentationContexts ( BookPresentationContext or PortletPresentationContext ) for this page. |
boolean |
isActive() Return true if this page is active. |
boolean |
isDisplayed() Return true if this page is being displayed. |
boolean |
isHidden() A hidden page is a page that does not show up as a tab in a book's menu. |
boolean |
isVisible() Returns true if this page is visible. |
Methods inherited from class com.bea.netuix.servlets.controls.window.WindowPresentationContext |
---|
getCapability, getContentAttributeRenderer, getContentPresentationClass, getContentPresentationContextChildren, getContentPresentationStyle, getDefinitionId, getDefinitionLabel, getInstanceId, getLocalInstanceId, getMetaData, getMetaDatas, getOrientation, getParentPagePresentationContext, getPreviousWindowMode, getThemePresentationContext, getTitle, getTitlebarPresentationContext, getWindowMode, getWindowPresentationContext, getWindowState, isCapable, isPacked |
Methods inherited from class com.bea.netuix.servlets.controls.PresentationContext |
---|
addCookie, addDateHeader, addHeader, addIntHeader, getAttributeRenderer, getChildren, getChildren, getFirstChild, getOrderedChildren, getParsedProperties, getPresentationClass, getPresentationId, getPresentationStyle, getProperties, getProperty, getProperty, getPropertyAsBoolean, getPropertyAsInt, getRenderFormat, getResolvedLocale, getTagName, setCharacterEncoding, setContentType, setVisible |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final String CLASS_NAME
Method Detail |
---|
public boolean isHidden()
public boolean isActive()
isDisplayed()
in that an active page is not necessarily always displayed, since the parent book may not itself be active. Active pages can have an inactive parent book but when the parent is activated again the current page is remembered.public boolean isVisible()
isDisplayed()
and isActive()
. Generaly this method is useless as the pages that are not being displayed are suspended
and never get visible set to false. It is recommended that you use isDisplayed()
or isActive()
instead.isVisible
in class PresentationContext
public boolean isDisplayed()
isActive()
in that an active page is not necessarily always displayed, since the parent book may not be active.public String getLabel()
WindowPresentationContext.getDefinitionLabel()
.getLabel
in class WindowPresentationContext
public List getWindowPresentationContexts()
BookPresentationContext
or PortletPresentationContext
) for this page. If no child portlets and books exist, this returns an empty list.public String getActiveImage()
public String getInactiveImage()
public String getRolloverImage()
public BookPresentationContext getBookPresentationContextRecursive(String definitionLabel)
getPagePresentationContextRecursive(java.lang.String)
as that method returns both.definitionLabel
- The definitionLabel of the desired bookpublic PagePresentationContext getPagePresentationContextRecursive(String definitionLabel)
definitionLabel
- The definitionLabel of the desired pagepublic PortletPresentationContext getPortletPresentationContextRecursive(String instanceLabel)
PortletPresentationContext
matching the supplied instance label.instanceLabel
- The Unique instance label of the desired portletpublic PortletPresentationContext[] getPortletsPresentationContextRecursive(String definitionLabel)
PortletPresentationContext
s matching the supplied definition label. Since many portlets can share the same definition label, more then one portlet can be returned. If you are interested in just one portlet then try getPortletPresentationContextRecursive(java.lang.String)
.definitionLabel
- The label of the portlet(s)public BookPresentationContext getParentBookPresentationContext()
Get the presentation context for the parent book.
May return null if the page is not nested within a book.public static PagePresentationContext getPagePresentationContext(javax.servlet.http.HttpServletRequest request)
PagePresentationContext
. Note this method will only work if called from within a portal (typically, from the page.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.request
- The current HTTPServletRequest instance
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010, Oracle. All rights reserved.