s (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
getLabel() Method
public String
getLabel()
Gets the label for this book. This is equivalent to calling BookPresentationContext.getDefinitionLabel()
.
-
Overrides
-
PagePresentationContext.getLabel()
getPageCount() Method
public int getPageCount()
Return the total number of pages contained in this book.
Returns
- The total number of pages
getPagePresentationContext(String) Method
public PagePresentationContext
getPagePresentationContext(String
instanceId)
Return a page from the list of pages for this book. If the page does not exist, null is returned.
Note this method will not search recursively, if you need that functionality call
BookPresentationContext.getPagePresentationContextRecursive(String)
.
Returns
- An immediate page child for the given instanceId, or null if it does not exist
getPagePresentationContextByUniqueId(String) Method
public PagePresentationContext
getPagePresentationContextByUniqueId(String
uniqueId)
Return a page from the list of pages for this book. If the page does not exist or
this is called from a .portal file, null is returned.
Returns
- The PagePresentationContext for the unique id, or null if it is not found
getPagePresentationContextByUnqiueId(String) Method
DEPRECATED Misspelled method name; use com.bea.netuix.servlets.controls.page.BookPresentationContext.getPagePresentationContextByUniqueId(java.lang.String)
public PagePresentationContext
getPagePresentationContextByUnqiueId(String
uniqueId)
Return a page from the list of pages for this book. If the page does not exist, null is returned.
Returns
- The PagePresentationContext for the unique id, or null if it is not found
getPagePresentationContextRecursive(String) Method
public 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.
-
Overrides
-
PagePresentationContext.getPagePresentationContextRecursive(String)
Parameters
-
definitionLabel
- The definitionLabel of the desired page or book
Returns
- A PagePresentationContext (or BookPresentationContext if a book) of the page or book with a
matching definition label
getPagePresentationContexts() Method
DEPRECATED Use com.bea.netuix.servlets.controls.page.BookPresentationContext.getEntitledPagePresentationContexts()
public ArrayList
getPagePresentationContexts()
Return the collection of PagePresentationContext
s (which may be either
BookPresentationContext
or PagePresentationContext
objects) for this book.
If no pages exist returns an empty list.
Returns
- An ArrayList of PagePresentationContext and/or BookPresentationContext objects
Related Topics
BookPresentationContext.getEntitledPagePresentationContexts()
getPortletPresentationContextRecursive(String) Method
public PortletPresentationContext
getPortletPresentationContextRecursive(String
instanceLabel)
Return the PortletPresentationContext
matching the supplied instance label.
-
Overrides
-
PagePresentationContext.getPortletPresentationContextRecursive(String)
Parameters
-
instanceLabel
- The unique instance label for the desired portlet
Returns
- A reference to the PortletPresentationContext if it exists; null otherwise
getPortletsPresentationContextRecursive(String) Method
public PortletPresentationContext
[] getPortletsPresentationContextRecursive(String
definitionLabel)
Returns 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
BookPresentationContext.getPortletPresentationContextRecursive(String)
.
-
Overrides
-
PagePresentationContext.getPortletsPresentationContextRecursive(String)
Parameters
-
definitionLabel
- The definition label for the desired portlet(s)
Returns
- A non-null array of PortletPresentationContexts
isContained() Method
public 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. This is useful for formatting the book differently when it
is a child of such a component.
Returns
- True, if this book is directly contained by another book or window
isDesktopBook() Method
public 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.
Returns
- True, if this is the primary book in the portal
isLikePage() Method
public boolean isLikePage()
Indicates whether or not this book is a page in another book.
Returns
- True, if this book is a page in another book