|
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 |
public interface LayoutView
The Layout view contains all the Page's Portlets and Books and the information needed to organize these object on the user's screen. These portlets and books are laid out in different layout locations called placeholders and are also positioned within the placeholder themselves.
"Views" are deep copy immutable objects. Unlike "Definitions" and "Instances" Views cannot be modified by the developer. An Instance or a Definition however can always be obtained from the view. The persistence APIs provide coarse 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, but if you are only interested in the immediate object and don't care about its children then retrieve the Definition.
View
Method Summary | |
---|---|
int |
getBookCount() Convenience method to count the total number of books within the placeholders in this layout. |
BookView[] |
getBookViews() Get an array of all the books within the placeholders in this layout. |
LayoutDefinition |
getLayoutDefinition() Retrieve the associated LayoutDefinition from this Layout View. |
LayoutDefinitionId |
getLayoutDefinitionId() Getter for the layout definition id. |
LocalizationResourceView |
getLocalizationResourceView() The Localization resource contains the localized title and description for this layout. |
int |
getPlaceableCount() Convenience method to count the total number of placeables (books or portlets) within the placeholders in this layout. |
PlaceableView[] |
getPlaceableViews() Return all the placeables (books and portlets) in all the placeholder on this page. |
int |
getPlaceholderCount() Convenience method to get the number of placeholders for this layout. |
PlaceholderView |
getPlaceholderView(int layoutLocation) Get the placeholder for a given layout location. |
PlaceholderView |
getPlaceholderView(PlaceholderDefinitionId placeholderDefinitionId) Get the placeholder for a given database definition ID. |
PlaceholderView[] |
getPlaceholderViews() Get all placeholders for this layout. |
int |
getPortletCount() Convenience method to count the total number of portlets within the placeholders in this layout. |
PortletView |
getPortletViewRecursive(String portletInstanceLabel) Retrieve a PortletView matching the supplied portlet instance label, searching the entire tree starting at this layout and recursing all nested books and pages. |
PortletView[] |
getPortletViews() Get an array of all the portlets within the placeholders in this layout. |
String |
getThumbnailUri() Get the URI to the thumbnail representation. |
String |
getWebAppName() Return the name of the webapp that this layout is associated with. |
boolean |
isDeleted() If isDeleted is true then the layout has been removed from the file system. |
Methods inherited from interface com.bea.netuix.application.view.MarkupBasedView |
---|
getMarkupView |
Methods inherited from interface com.bea.netuix.application.view.View |
---|
getDescription, getTitle |
Method Detail |
---|
LayoutDefinitionId getLayoutDefinitionId()
Getter for the layout definition id. The layout id is the primary key value for the layout definition in the PF_LAYOUT_DEFINITION table. Unlike Book, Pages, and Portlets, Layouts do not have instances. The admin or end user can still change a layout but that means customizing the page, not the layout.
LayoutDefinition getLayoutDefinition()
Retrieve the associated LayoutDefinition
from this Layout View. Layout Views are immutable but 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. The Layout Definition is constructed and updated via its .layout file. If you create a new .layout file then a new Layout Definition is created in the database. If you edit the file the changes are automatically seen in the database (during dev time we poll the file system and in production we update the database whenever the webapp is redeployed).
LocalizationResourceView getLocalizationResourceView()
The Localization resource contains the localized title and description for this layout.
PlaceholderView[] getPlaceholderViews()
PlaceholderView getPlaceholderView(PlaceholderDefinitionId placeholderDefinitionId)
PlaceholderView getPlaceholderView(int layoutLocation)
int getPlaceholderCount()
PortletView[] getPortletViews()
int getPortletCount()
BookView[] getBookViews()
int getBookCount()
PlaceableView[] getPlaceableViews()
int getPlaceableCount()
String getWebAppName()
boolean isDeleted()
String getThumbnailUri()
PortletView getPortletViewRecursive(String portletInstanceLabel)
Retrieve a PortletView matching the supplied portlet instance label, searching the entire tree starting at this layout and recursing all nested books and pages.
portletInstanceLabel
- the instance label of the portlet
|
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.