|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
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 com.bea.netuix.servlets.controls.page.BookPresentationContext
public class BookPresentationContext
This class represents a portal book component. All presentation-related attributes of a book component are available from instances of this class. Such instances are typically used during portal rendering via look and feel skeleton files (e.g. book.jsp).
getBookPresentationContext(javax.servlet.http.HttpServletRequest)
,
Serialized FormField Summary | |
---|---|
protected static String |
CLASS_NAME
|
Method Summary | |
---|---|
String |
getActivePage()
Get the currently active page's label. |
static BookPresentationContext |
getBookPresentationContext(javax.servlet.http.HttpServletRequest request)
This is a convenience method for returning a reference to the current BookPresentationContext . |
BookPresentationContext |
getBookPresentationContextRecursive(String definitionLabel)
Return a book searching the entire tree recursively. |
String |
getCurrentPage()
Deprecated Use getActivePage() instead |
String |
getDefaultPage()
The default page's label as specified for the book. |
List |
getEntitledPagePresentationContexts()
Return the collection of entitled PagePresentationContext |
String |
getLabel()
Gets the label for this book. |
MenuPresentationContext |
getMenuPresentationContext()
Get the presentation context corresponding to the menu for this book. |
int |
getPageCount()
Return the total number of pages contained in this book. |
PagePresentationContext |
getPagePresentationContext(String instanceId)
Return a page from the list of pages for this book. |
PagePresentationContext |
getPagePresentationContextByUniqueId(String uniqueId)
Return a page from the list of pages for this book. |
PagePresentationContext |
getPagePresentationContextByUnqiueId(String uniqueId)
Deprecated Misspelled method name; use getPagePresentationContextByUniqueId(String) |
PagePresentationContext |
getPagePresentationContextRecursive(String definitionLabel)
Return a book or a page but traverse the entire tree, this will go inside books that are on pages too. |
ArrayList |
getPagePresentationContexts()
Deprecated Use getEntitledPagePresentationContexts() |
PortletPresentationContext |
getPortletPresentationContextRecursive(String instanceLabel)
Return the PortletPresentationContext matching the supplied instance label. |
PortletPresentationContext[] |
getPortletsPresentationContextRecursive(String definitionLabel)
Returns PortletPresentationContext s matching the supplied definition label. |
boolean |
isContained()
Returns true if the Book represented by this presentation context is "contained", that is if the the Book's next Book, Window, or Page ancestor is a Book or Window then it is contained and this method will return true. |
boolean |
isDesktopBook()
Returns true if the Book represented by this presentation context is the desktop Book in otherwords is it the top most Book in the control tree. |
boolean |
isLikePage()
Indicates whether or not this book is a page in another book. |
Methods inherited from class com.bea.netuix.servlets.controls.page.PagePresentationContext |
---|
getActiveImage, getInactiveImage, getPagePresentationContext, getParentBookPresentationContext, getRolloverImage, getWindowPresentationContexts, isActive, isDisplayed, isHidden, isVisible |
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 |
---|
getAttributeRenderer, getChildren, getChildren, getFirstChild, getOrderedChildren, getParsedProperties, getPresentationClass, getPresentationId, getPresentationStyle, getProperties, getProperty, getProperty, getPropertyAsBoolean, getPropertyAsInt, getRenderFormat, getResolvedLocale, getTagName, 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 String getLabel()
WindowPresentationContext.getDefinitionLabel()
.
getLabel
in class PagePresentationContext
public String getDefaultPage()
@Deprecated public String getCurrentPage()
getActivePage()
instead
getActivePage()
.
getActivePage()
public String getActivePage()
public MenuPresentationContext getMenuPresentationContext()
@Deprecated public ArrayList getPagePresentationContexts()
getEntitledPagePresentationContexts()
PagePresentationContext
s (which may be either
BookPresentationContext
or PagePresentationContext
objects) for this book.
If no pages exist returns an empty list.
getEntitledPagePresentationContexts()
public List getEntitledPagePresentationContexts()
PagePresentationContexts (which may be either
BookPresentationContext
or PagePresentationContext
objects) for this book.
If no pages exist returns an empty list.
- Returns
- A list of PagePresentationContext and/or BookPresentationContext objects
public int getPageCount()
public boolean isDesktopBook()
public boolean isContained()
public boolean isLikePage()
public PagePresentationContext getPagePresentationContext(String instanceId)
getPagePresentationContextRecursive(java.lang.String)
.
@Deprecated public PagePresentationContext getPagePresentationContextByUnqiueId(String uniqueId)
getPagePresentationContextByUniqueId(String)
public PagePresentationContext getPagePresentationContextByUniqueId(String uniqueId)
public BookPresentationContext getBookPresentationContextRecursive(String definitionLabel)
getPagePresentationContextRecursive(java.lang.String)
as that method returns both.
getBookPresentationContextRecursive
in class PagePresentationContext
definitionLabel
- The definitionLabel of the desired book
public PagePresentationContext getPagePresentationContextRecursive(String definitionLabel)
getPagePresentationContextRecursive
in class PagePresentationContext
definitionLabel
- The definitionLabel of the desired page or book
public PortletPresentationContext getPortletPresentationContextRecursive(String instanceLabel)
PortletPresentationContext
matching the supplied instance label.
getPortletPresentationContextRecursive
in class PagePresentationContext
instanceLabel
- The unique instance label for the desired portlet
public PortletPresentationContext[] getPortletsPresentationContextRecursive(String definitionLabel)
PortletPresentationContext
s matching the supplied definition label.
Since many portlets can share the same definition label, more than one portlet
can be returned. If you are interested in just one portlet then try
getPortletPresentationContextRecursive(java.lang.String)
.
getPortletsPresentationContextRecursive
in class PagePresentationContext
definitionLabel
- The definition label for the desired portlet(s)
public static BookPresentationContext getBookPresentationContext(javax.servlet.http.HttpServletRequest request)
BookPresentationContext
.
Note this method will only work if called from within a portal (typically, from the book.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
|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |