MarkupBasedView
"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.
View class for a placeholder. A placeholder will hold a set of placeables, i.e. portlets and/or books.Related Topics
MarkupBasedView
, Serializable
, View
Method Summary |
public int |
|
public |
|
public |
|
public int |
|
public int |
|
public |
|
public |
|
public |
|
public int |
|
public |
|
public |
|
Methods from interface com.bea.netuix.application.view. |
|
Methods from interface com.bea.netuix.application.view. |
|
Method Detail |
public int getBookCount()Convenience method to count all books held by this placeholder.
public BookView
[] getBookViews()
Get all books held by this placeholder. Returns an empty array if there are none.
public LocalizationResourceView
getLocalizationResourceView()
The Localization resource contains the localized title and description for this placeholder.
public int getLocation()Return this placeholders layout location. The location is an integer representing column or location in the layout. example: 0 == first column
public int getPlaceableCount()Convenience method to count all placeables (books or portlets) held by this placeholder.
public PlaceableView
[] getPlaceableViews()
Get all placeables (books or portlets) held by this placeholder. Returns an empty array if there are none.
public PlaceholderDefinition
getPlaceholderDefinition()
Retrieve the associated PlaceholderDefinition
from this Placeholder View. Placeholder Views are
immutable but Placeholder Instances and Placeholder 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 PlaceholderDefinitionId
getPlaceholderDefinitionId()
Getter for placeholder definition id. The placeholder id is the primary key value for the shell definition in the PF_PLACEHOLDER_DEFINITION table. Unlike Book Pages and Portlets, placeholdes do not have instances. The admin or end user can still change his or her palceholder but they are customizing the page not the placeholder.
public int getPortletCount()Convenience method to count all portlets held by this placeholder.
publicGet the portlet for a given database instance ID. Return null if there is no such portlet.PortletView
getPortletView(PortletInstanceId
portletId)
public PortletView
[] getPortletViews()
Get all portlets held by this placeholder. Returns an empty array if there are none.