|
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.BackingContext
com.bea.netuix.servlets.controls.window.backing.WindowBackingContext
com.bea.netuix.servlets.controls.page.PageBackingContext
com.bea.netuix.servlets.controls.page.BookBackingContext
public class BookBackingContext
This is the backing context for a book. 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 BookPresentationContext instead.
Call getContextFromRequest
to obtain the backing context for the active window.
Field Summary | |
---|---|
protected static String |
CLASS_NAME |
Method Summary | |
---|---|
PageBackingContext |
getActivePageBackingContext() Return the PageBackingContext (or BookBackingContext) of the active Page or null if there is none. |
static BookBackingContext |
getBookBackingContext(javax.servlet.http.HttpServletRequest request) Obtain a reference to the current BookBackingContext in the request. |
BookBackingContext |
getBookBackingContextRecursive(String definitionLabel) Return a book with a given label searching the entire tree recursively. |
BackingContext |
getContainerParentBackingContext() Returns the next "container" (Window, Page, or Book) ancestor BackingContext . |
String |
getCurrentPage() Returns the instanceId of the current Page |
String |
getDefaultPage() Return the value of the underlying object's defaultPage attribute. |
List |
getEntitledPages() Deprecated use getPageBackingContexts() |
PageBackingContext |
getFirstDisplayedPageBackingContext() Return the first Page (not Book) that is being displayed on this book, this method will recursively travel down all the sub books on this book until it finds page a that is active. |
MenuBackingContext |
getMenuBackingContext() Get the backing context corresponding to the menu for this book. |
PageBackingContext |
getPageBackingContextByDefinitionLabel(String definitionLabel) Returns the PageBackingContext of the child page specified by definitionLabel . |
PageBackingContext |
getPageBackingContextByInstanceId(String instanceId) Returns the PageBackingContext of the child page specified by instanceId . |
PageBackingContext |
getPageBackingContextByUnqiueId(String uniqueId) Returns the PageBackingContext of the child page specified by uniqueId . |
PageBackingContext |
getPageBackingContextRecursive(String definitionLabel) Return a book or a page with a given label, traversing the entire tree to find it. |
List |
getPageBackingContexts() Return the collection of BackingContexts (BookBackingContexts and PageBackingContexts) for the pages and books contained by the book this BackingContext represents. |
int |
getPageCount() Return the number of pages contained in the book that this BackingContext represents. |
List |
getPages() Deprecated Use getPageBackingContexts() instead. |
PortletBackingContext |
getPortletBackingContextRecursive(String instanceLabel) Return the portlet backing context matching the supplied instance label. |
PortletBackingContext[] |
getPortletsBackingContextRecursive(String definitionLabel) Return all portlet backing contexts matching the supplied definition label. |
boolean |
isContained() Returns true if the book represented by this backing context is "contained", that is if the the book's next book, window, or page ancestor is a book or window. |
boolean |
isDesktopBook() Returns true if the book represented by this backing context is the desktop Book (i.e. |
boolean |
isLikePage() Indicates whether or not the underlying book is a page in another book. |
Methods inherited from class com.bea.netuix.servlets.controls.page.PageBackingContext |
---|
getActiveImage, getInactiveImage, getLabel, getMarkupName, getMarkupType, getPageBackingContext, getParentBookBackingContext, getParentPageBackingContext, getRolloverImage, getWindowBackingContexts, isActive, isDisplayed, isHidden, setActive, setActiveImage, setHidden, setInactiveImage, setRolloverImage |
Methods inherited from class com.bea.netuix.servlets.controls.window.backing.WindowBackingContext |
---|
getCapability, getCapabilityVisible, getDefinitionId, getDefinitionLabel, getDescription, getInstanceId, getMetaData, getMetaDatas, getOrientation, getParentWindowBackingContext, getPlacementId, getPreviousWindowMode, getPreviousWindowState, getRenderedChildrenWindowBackingContexts, getTitle, getWindowMode, getWindowState, isCapable, isPacked, setCapabilityVisible, setDescription, setTitle, setupModeChangeEvent, setupModeChangeEvent, setupPageChangeEvent, setupStateChangeEvent, setupStateChangeEventFromParent |
Methods inherited from class com.bea.netuix.servlets.controls.BackingContext |
---|
ensureCurrentLifecycleStageLegalForOperation, getChildrenBackingContexts, getParentBackingContext, getParsedProperties, getProperties, getProperty, getProperty, getSendRedirectPath, getTopParentBackingContext, isBackingPhase, isVisible, sendRedirect, setBackingPhase, 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 isDesktopBook()
public boolean isContained()
public PageBackingContext getActivePageBackingContext()
getFirstDisplayedPageBackingContext
method.public PageBackingContext getFirstDisplayedPageBackingContext()
public String getCurrentPage()
Book.getCurrentPage()
public String getDefaultPage()
defaultPage
attribute.defaultPage
attribute.public PageBackingContext getPageBackingContextByInstanceId(String instanceId)
instanceId
. If the page is not found, null is returned. This method does not recursively go down the tree.public PageBackingContext getPageBackingContextByUnqiueId(String uniqueId)
uniqueId
. If the page is not found, null is returned. This method does not recursively go down the tree.public PageBackingContext getPageBackingContextByDefinitionLabel(String definitionLabel)
definitionLabel
. If the page is not found, null is returned. This method does not recursively go down the tree.public int getPageCount()
Book.getPageCount()
public List getPageBackingContexts()
@Deprecated
public List getPages()
@Deprecated
public List getEntitledPages()
Return the collection of entitled BackingContexts (BookBackingContexts and PageBackingContexts) for the pages and books contained by the book this BackingContext represents. This method filters out pages that are hidden or for which entitlements are not sufficient to view.
public static BookBackingContext getBookBackingContext(javax.servlet.http.HttpServletRequest request)
Obtain a reference to the current BookBackingContext
in the request. Note: the BookBackingContext should only be obtained from a backing file. If you think you need this context from a JSP, look at BookPresentationContext.
request
- http servlet request.public boolean isLikePage()
true
if underlying book is a page in another bookpublic BackingContext getContainerParentBackingContext()
BackingContext
.BackingContext
or null if there is nonepublic BookBackingContext getBookBackingContextRecursive(String definitionLabel)
getPageBackingContextRecursive()
as that method returns both. Note: this method may return null if called from the init() method of a backing context.getBookBackingContextRecursive
in class PageBackingContext
definitionLabel
- of the bookpublic PageBackingContext getPageBackingContextRecursive(String definitionLabel)
getPageBackingContextRecursive
in class PageBackingContext
definitionLabel
-public PortletBackingContext getPortletBackingContextRecursive(String instanceLabel)
getPortletBackingContextRecursive
in class PageBackingContext
instanceLabel
- unique instance label of the portletpublic PortletBackingContext[] getPortletsBackingContextRecursive(String definitionLabel)
getPortletBackingContextRecursive(String instanceLabel)
Note: this method may return null if called from the init() method of a backing context.getPortletsBackingContextRecursive
in class PageBackingContext
definitionLabel
- label of the portletpublic MenuBackingContext getMenuBackingContext()
|
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.