|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DesktopView
The Desktop View is the highest level View object. When retrieving this object you will get all the child objects contained within a portal.
"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.
A desktop can be obtained in "deep" (the default) or "shallow" mode. In shallow mode, the main book view object is created in shallow mode (see comments for BookView), and all querying methods for book, page, and portlet view objects will return null. By default, DesktopViews are constructed in deep mode. There are specific methods in the portal persistence API to retrieve shallow desktop views. If a DesktopView was constructed in shallow mode, then any child BookView or PageView obtained by traversing View children will be shallow.
View
Method Summary | |
---|---|
String |
getAsyncContent()
Deprecated use getAsyncMode(); |
String |
getAsyncMode()
The async mode attribute is used to determine if the desktop should rendered in AJAX mode. |
BookView |
getBookView()
Get the primary book for this desktop. |
BookView |
getBookViewRecursive(BookDefinitionId bookDefinitionId)
Get the book for a given database definition ID, searching the entire tree of nested books and pages within this desktop. |
BookView |
getBookViewRecursive(BookInstanceId bookInstanceId)
Get the book for a given database instance ID, searching the entire tree of nested books within this desktop. |
BookView |
getBookViewRecursive(String bookDefinitionLabel)
Get the book for a given definition label, searching the entire tree of nested books within this desktop. |
DesktopDefinition |
getDesktopDefinition()
Retrieve the associated DesktopDefinition from this Desktop View. |
DesktopDefinitionId |
getDesktopDefinitionId()
Getter for the desktop definition id. |
DesktopInstance |
getDesktopInstance()
Retrieve the associated DesktopInstance from this Desktop View. |
DesktopInstanceId |
getDesktopInstanceId()
Getter for the Desktop instance id. |
DesktopType.DesktopTypeValue |
getDesktopType()
Returns the type of this desktop. |
LocalizationResourceView |
getLocalizationResourceView()
The Localization resource contains the localized title and description for this desktop. |
LookAndFeelView |
getLookAndFeelView()
Get the LookAndFeel associated with this desktop. |
PageView |
getPageViewRecursive(PageDefinitionId pageDefinitionId)
Get the page for a given database definition ID, searching the entire tree of nested books within this desktop. |
PageView |
getPageViewRecursive(PageInstanceId pageInstanceId)
Get the page for a given database instance ID, searching the entire tree of nested books within this desktop. |
PageView |
getPageViewRecursive(String pageDefinitionLabel)
Get the book for a given definition label, searching the entire tree of nested books within this desktop. |
PortletView |
getPortletViewRecursive(PortletInstanceId portletInstanceId)
Get the portlet for a given database instance id, searching the entire tree of nested books within this desktop. |
PortletView |
getPortletViewRecursive(String instanceLabel)
Get the portlet for a given instance label, searching the entire tree of nested books within this desktop. |
ShellView |
getShellView()
Retrieve the shell for this desktop. |
boolean |
isDisc()
The gooEnabled attribute is used to enable/disable the WLP "Goo" JavaScript framework. |
boolean |
isDvt()
The dvtEnabled attribute is used to enable/disable the WLP Dynamic Visitor Tooling functionality. |
boolean |
isGlobal()
Returns true if this desktop is a template that is global. |
boolean |
isScrollToWindow()
The scrollToWindow feature will scroll the browser view to the Window
that the user last interacted with on postback requests. |
boolean |
isTemplate()
Returns true if this desktop is a template. |
boolean |
isTreeOptimization()
Is UIControl tree optimization enabled? |
Methods inherited from interface com.bea.netuix.application.view.MarkupBasedView |
---|
getMarkupView |
Methods inherited from interface com.bea.netuix.application.view.View |
---|
getDescription, getTitle |
Methods inherited from interface com.bea.netuix.application.view.ParentView |
---|
getBookView, getBookViewsRecursive, getPageView, getPageViewsRecursive |
Method Detail |
---|
DesktopInstanceId getDesktopInstanceId()
Getter for the Desktop instance id. The instance id is the primary key value for the Desktop instance in the PF_DESKTOP_INSTANCE table. A Desktop Definition may have many instance; these instance are created when administrators or users customize their portal. A Desktop Definition always has at least one instance, namely the "primary" instance.
DesktopDefinitionId getDesktopDefinitionId()
Getter for the desktop definition id. The definition id is the primary key value for the desktop definition in the PF_DESKTOP_DEFINITION table. The desktop definition id differs from other portal ids in that it is not an auto generated field. It is a composite primary key derived from three fields: The web app name, the portal path and the desktop path. A Desktop Definition always has at least one instance namely the "primary" instance.
DesktopInstance getDesktopInstance()
Retrieve the associated DesktopInstance
from this Desktop View. Desktop Views are immutable but
Instances and 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.
DesktopDefinition getDesktopDefinition()
Retrieve the associated DesktopDefinition
from this Desktop View. Desktop 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.
LocalizationResourceView getLocalizationResourceView()
The Localization resource contains the localized title and description for this desktop.
ShellView getShellView()
Retrieve the shell for this desktop. A Shell represents an area on the desktop that is created by the developer and is immutable via the persistence API. Shells, however, can be swapped out on a desktop.
BookView getBookView()
Get the primary book for this desktop. This BookView represent the main book view on the desktop.
LookAndFeelView getLookAndFeelView()
Get the LookAndFeel associated with this desktop.
BookView getBookViewRecursive(BookInstanceId bookInstanceId)
getBookViewRecursive
in interface ParentView
BookView getBookViewRecursive(BookDefinitionId bookDefinitionId)
getBookViewRecursive
in interface ParentView
BookView getBookViewRecursive(String bookDefinitionLabel)
getBookViewRecursive
in interface ParentView
PageView getPageViewRecursive(PageInstanceId pageInstanceId)
getPageViewRecursive
in interface ParentView
PageView getPageViewRecursive(String pageDefinitionLabel)
getPageViewRecursive
in interface ParentView
PageView getPageViewRecursive(PageDefinitionId pageDefinitionId)
getPageViewRecursive
in interface ParentView
PortletView getPortletViewRecursive(PortletInstanceId portletInstanceId)
getPortletViewRecursive
in interface ParentView
portletInstanceId
- as defined in the database.
PortletView getPortletViewRecursive(String instanceLabel)
getPortletViewRecursive
in interface ParentView
instanceLabel
- the instance label of the portlet.
boolean isTreeOptimization()
DesktopType.DesktopTypeValue getDesktopType()
DesktopType
boolean isTemplate()
boolean isGlobal()
@Deprecated String getAsyncContent()
String getAsyncMode()
boolean isScrollToWindow()
Window
that the user last interacted with on postback requests. This flag identifies
whether or not the feature is enabled. Defaults to false.
boolean isDisc()
boolean isDvt()
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |