|
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 MenuView
View class for a menu. A Menu is an optional component on a book and is responsible for rendering a set of tabs or other navigation component to navigate across the book's pages. Menus are optional because page change events can be triggered by other means, such as links, trees or backing files.
"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.
Menus are typically created via .menu files but can be create via the API directly.
View
Method Summary | |
---|---|
LocalizationResourceView |
getLocalizationResourceView()
The Localization resource contains the localized title and description for this menu. |
MenuDefinition |
getMenuDefinition()
Retrieve the associated MenuDefinition from this Menu View. |
MenuDefinitionId |
getMenuDefinitionId()
Getter for the menu definition id. |
String |
getMenuFile()
Retrieve the file name used to create this menu. |
String |
getThumbnailUri()
Get the URI to the thumbnail representation. |
String |
getWebAppName()
Return the name of the webapp that this menu is associated with. |
boolean |
isDeleted()
If isDeleted is true then the menu 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 |
---|
MenuDefinitionId getMenuDefinitionId()
Getter for the menu definition id. The menu id is the primary key value for the menu definition in the PF_MENU_DEFINITION table. Unlike Book, Pages, and Portlets, menus do not have instances. The admin or end-user can still change the menu used for a book, but they are customizing the book and not the menu.
MenuDefinition getMenuDefinition()
Retrieve the associated MenuDefinition
from this Menu View. Menu Views are immutable but
Menu 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 Menu Definition is constructed
(in the database) and updated via its .menu file. If you create a new .menu file then a new Menu 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 periodically 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 menu.
String getWebAppName()
Return the name of the webapp that this menu is associated with. All resources in the portal framework database are scoped to the webapp.
String getMenuFile()
Retrieve the file name used to create this menu. Menus are created via .menu files
boolean isDeleted()
If isDeleted is true then the menu has been removed from the file system. It was not outright deleted from the database because it is in use by some desktop somewhere in the system. Either restore the file and this flag will go back to false or remove/replace this menu via the admin tools.
If this flag is set on an object the admin tools will display the object with a different icon to denote that it has been removed from the file system.
String getThumbnailUri()
|
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 |