NavigableView
, ThemedMarkupBasedView
"Views" are deep copy immutable objects. Unlike "Definitions" and "Instances" Views cannot be modified by the developer. A Instance or a Definition however can always be obtained from the view. The persistence APIs provides course grain and fine grain getters but only fine grain setters. If you are interested in an object and all its children then retrieve the View, if you are only interested in the immediate object and don't care about its children then retrieve the Definition.
The page view represents a page and all its contents. Pages are used to display child Portlets and child Books in a specific layout in a browser. A common term/interface used to represent things that can be placed on a page is "Placeable". So both Book and Portlet extend Placeable. There is no theoretical limit to the number of placeables a page may contain.MarkupBasedView
, NavigableView
, Serializable
, ThemedMarkupBasedView
, View
Field Summary |
Fields from interface com.bea.netuix.application.view. |
|
Method Summary |
public int |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public int |
|
public |
|
public |
|
public int |
|
public |
|
public int |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
Methods from interface com.bea.netuix.application.view. |
|
Methods from interface com.bea.netuix.application.view. |
|
Methods from interface com.bea.netuix.application.view. |
|
Methods from interface com.bea.netuix.application.view. |
|
Method Detail |
public int getBookCount()
A convenience method for retrieving a total count of all the books in all the placeholders on this page.
This method counts immediate children only.
public BookGroupId
getBookGroupId()
Getter for page's book group id. The book group id represents a unique placement of a page on a book. Book may contain Pages just like they may contain Books. If this page is placed on a Book then this book group id represents the primary key value of the PF_BOOK_GROUP.BOOK_GROUP_ID value in the database. If this view was obtained directly and not from a parent view object then this value may be null.
publicRetrieve a child BookView matching the supplied label. This method returns immediate children only.BookView
getBookView(String
label)
publicRetrieve a BookView matching the supplied database instance ID. This method returns immediate children only.BookView
getBookView(BookInstanceId
bookInstanceId)
publicRetrieve a BookView matching the supplied database instance ID, searching the entire tree of nested books.BookView
getBookViewRecursive(BookInstanceId
bookInstanceId)
publicRetrieve a BookView matching the supplied database definition label, searching the entire tree of nested books.BookView
getBookViewRecursive(String
bookDefinitionLabel)
public BookView
[] getBookViews()
Retrieves a list of all books in all placeholders on this page. For an ordered list
see getPlaceableViews()
public LayoutView
getLayoutView()
Retrieve the child layout view associated with this page. It is actually the layout that contains all the child placeables.
public LocalizationResourceView
getLocalizationResourceView()
The Localization resource contains the localized title and description for this look and feel.
public PageDefinition
getPageDefinition()
Retrieve the associated PageDefinition
from this Page View. Page Views are immutable but
Instances and Definitions are not. Therefore it is often necessary to retrieve the definition from the view in
order to update its values and then in turn call the persistence API.
public PageDefinitionId
getPageDefinitionId()
Getter for page definition id. The definition id is the primary key value for the page definition in the PF_PAGE_DEFINITION table. A Page Definition may have many instance these instance are created when administrators or users customize their portal. A Page Definition always has at least one instance namely the "primary" instance.
public PageInstance
getPageInstance()
Retrieve the associated PageInstance
from this Page View. Page Views are immutable but
Page Instances and Book Definitions are not. Therefore it is often necessary to retrieve the instance from the view in
order to update its values and then in turn call the persistence API.
public PageInstanceId
getPageInstanceId()
Getter for page instance id. The instance id is the primary key value for the page instance in the PF_PAGE_INSTANCE table. A Page Definition may have many instance these instance are created when administrators or users customize their portal. A Page Definition always has at least one instance namely the "primary" instance.
publicRetrieve a PageView matching the supplied database instance ID, searching the entire tree of nested books.PageView
getPageViewRecursive(PageInstanceId
pageInstanceId)
publicRetrieve a PageView matching the supplied database definition label, searching the entire tree of nested books.PageView
getPageViewRecursive(String
pageDefinitionLabel)
public int getPlaceableCount()
A convenience method for retieving a total count of all placeables (Books and Portlets) in all the placeholders on this page.
This method counts immediate children only.
publicPlaceableView
getPlaceableView(String
label)
Return a PlaceableView (PortletView or BookView) matching the supplied label.
Note: portlets are searched first, so if a book and a portlet have the same label (which is possible)
then the portletview would be returned. If you need the BookView or PortletView explicitly then call
getBookView(String defintionLabel)
or getPortletView(String instanceLabel)
.
public PlaceableView
[] getPlaceableViews()
A method for retrieving an ordered list of all the placeables (books and portlets) in all the placeholders on this page. For just a list of placeables in a particular placeholder see PlaceholderView.
public int getPlaceholderCount()
A convenience method for retieving a count of placeholders in the current layout on this page. This method counts immediate children only.
public PlaceholderView
[] getPlaceholderViews()
A method for retrieving an ordered list of all the placeholders in this page. The order of the
placeholders is determined by the placeholders getLocation()
index.
public int getPortletCount()
A convenience method for retrieving a total count of all the portlets in all the placeholders on this page.
This method counts immediate children only.publicRetrieve a PortletView matching the supplied instance label. This method returns immediate children only.PortletView
getPortletView(String
instanceLabel)
publicRetrieve a PortletView matching the supplied database instance ID. This method returns immediate children only.PortletView
getPortletView(PortletInstanceId
portletInstanceId)
publicRetrieve a PortletView matching the supplied database instance ID, searching the entire tree of nested books.PortletView
getPortletViewRecursive(PortletInstanceId
portletInstanceId)
publicPortletView
getPortletViewRecursive(String
portletInstanceLabel)
Retrieve a PortletView matching the supplied portlet instance label, searching the entire tree starting at this page and recursing all nested books, pages ...
public PortletView
[] getPortletViews()
Retrieves a list of all portlets in all placeholders on this page. For an ordered list
see getPlaceableViews()
publicRetrieve an array of PortletViews matching the supplied definition label. Since more then one instance can share the same definiiton lable we return an array This method returns immediate children only.PortletView
[] getPortletViews(String
definitionLabel)
public String
getWebAppName()
Return the name of the webapp that this page is associated with. All resources in the portal framework database are scoped to the webapp.