PageBackingContext Class
- public class PageBackingContext
extends WindowBackingContext
This is the backing context for a page. As such, it is meant to be called from backing
files or pageflows. If you want to access this context from a JSP,
look at PagePresentationContext instead.
Call getContextFromRequest
to obtain the backing context for the active window.
-
Hierarchy
-
Object
ControlContext
BackingContext
WindowBackingContext
PageBackingContext
-
All Implemented Interfaces
-
Serializable
-
Direct Known Subclasses
-
BookBackingContext
Methods from com.bea.netuix.servlets.controls.window.backing.WindowBackingContext |
getCapability , getCapabilityVisible , getDefinitionId , getDefinitionLabel , getDescription , getInstanceId , getOrientation , getParentWindowBackingContext , getPlacementId , getPreviousWindowMode , getPreviousWindowState , getRenderedChildrenWindowBackingContexts , getTitle , getWindowMode , getWindowState , isCapable , isPacked , setCapabilityVisible , setDescription , setTitle , setupModeChangeEvent , setupModeChangeEvent , setupPageChangeEvent , setupStateChangeEvent
|
Methods from com.bea.netuix.servlets.controls.ControlContext |
getContextFromRequest, getContextKey, getControl, getRequestKey, getUniqueId, removeContextFromRequest, setContextInRequest |
Methods from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
CLASS_NAME
protected static final String
CLASS_NAME
getActiveImage() Method
public String
getActiveImage()
Get the path to the image displayed in the menu tab when the page is active.
Returns
- the path to the image
getBookBackingContextRecursive(String) Method
public BookBackingContext
getBookBackingContextRecursive(String
definitionLabel)
Return a book searching the entire tree recursively.
If you are interested in both books AND pages use getPageBackingContextRecursive()
as that method returns both.
Note: this method may return null if called from the init() method of a backing context.
Parameters
-
definitionLabel
- of the book
Returns
- the Book of interest or null if not found.
getInactiveImage() Method
public String
getInactiveImage()
Get the path to the image displayed in the menu tab when the page is inactive.
Returns
- the path as defined in the IDE for the image when the page is inactive.
getLabel() Method
public String
getLabel()
Returns the definition label on the page
-
Overrides
-
WindowBackingContext.getLabel()
Returns
- the definition label of the page
getMarkupName() Method
public String
getMarkupName()
Returns the value of the Page's markupName attribute.
getMarkupType() Method
public String
getMarkupType()
Returns the value of the Page's markupType attribute.
getPageBackingContext(HttpServletRequest) Method
public static PageBackingContext
getPageBackingContext(HttpServletRequest
request)
Get the PageBackingContext from the request
getPageBackingContextRecursive(String) Method
public PageBackingContext
getPageBackingContextRecursive(String
definitionLabel)
Return a book or a page but traverse the entire tree.
The search will go inside books that are on pages too.
Note: this method may return null if called from the init() method of a backing context.
Returns
- pageBackingContext or (BookBackingContext if book) of the page or book with matching definition label.
getParentBookBackingContext() Method
public BookBackingContext
getParentBookBackingContext()
Returns the BookBackingContext of the book that is the parent of the
page represented by this context.
Returns
- the BookBackingContext of the Book that is the parent of the
page represented by this context, or null if there is no parent book.
Related Topics
Page#getBook()
getParentPageBackingContext() Method
public PageBackingContext
getParentPageBackingContext()
Returns the PageBackingContext of the Page that is the parent of the
page represented by this context.
Returns
- the PageBackingContext of the Page that is the parent of the
Page represented by this context or null if there is no parent page.
Related Topics
Page#getParentPage()
getPortletBackingContextRecursive(String) Method
public PortletBackingContext
getPortletBackingContextRecursive(String
instanceLabel)
Return the portlet backing context matching the supplied instance label.
Note: this method may return null if called from the init() method of a backing context.
Parameters
-
instanceLabel
- unique instance label of the portlet
Returns
- a reference to the portlet's BackingContext if it exist otherwise null.
getPortletsBackingContextRecursive(String) Method
public PortletBackingContext
[] getPortletsBackingContextRecursive(String
definitionLabel)
Return portlet backing contexts 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
getPortletBackingContextRecursive(String instanceLabel)
.
Note: this method may return null if called from the init() method of a backing context.
Parameters
-
definitionLabel
- label of the portlet
Returns
- a non null array of PortletBackingContext.
getRolloverImage() Method
public String
getRolloverImage()
Get the path to the rollover image to be displayed on the menu tab for this page.
getWindowBackingContexts() Method
public List
getWindowBackingContexts()
Return the collection of chils WindowBackingContexts (BookBackingContext
or PortletBackingContext) for this page.
If no portlets and books exist returns an empty list.
Returns
- List of
BookBackingContext and PortletBackingContext
s objects
isActive() Method
public boolean isActive()
Return true if this page is active. Note: this is different from isDisplayed
in that an active page is not necessarily always displayed as the parent book may not be active.
Active pages can have an inactive parent book but when the parent is activated again the
current page is remembered.
Returns
- true if the page/book is active.
isDisplayed() Method
public boolean isDisplayed()
Return true if this page is going to be displayed.
This method should be called late in the lifecycle preRender()
to determine if this
page will be displayed. If called earlier in the lifecycle handlePostBackData()
it will return
true if the page was previously display.
Note: this is different from isActive
in that an active page is not necessarily always displayed as the parent book may not be active.
Returns
- true or false
isHidden() Method
public boolean isHidden()
Return the value of the underlying object's hidden
attribute.
Returns
- a boolean, the value of the underlying object's
hidden
attribute.
setActive(boolean) Method
public void setActive(boolean active)
Set the value of the underlying object's active
attribute.
Parameters
-
active
- boolean, the new value of the underlying object's
active
attribute.
setActiveImage(String) Method
public void setActiveImage(String
activeImage)
Set the path to the image displayed in the menu tab when the page is active.
Parameters
-
activeImage
- a uri to the new activate image.
setHidden(boolean) Method
public void setHidden(boolean hidden)
Set the value of the underlying object's hidden
attribute.
Parameters
-
hidden
- boolean, the new value of the underlying object's
hidden
attribute.
setInactiveImage(String) Method
public void setInactiveImage(String
inactiveImage)
Set the path to the image displayed in the menu tab when the page is already active.
setRolloverImage(String) Method
public void setRolloverImage(String
rolloverImage)
Set the path to the rollover image to be displayed on the menu tab for this page.