(r3) XvwMenu < WebXEO

WebXEO Web>XeoXwc>XvwMenu (revision 3)~~EditAttach~~

-- PedroRio - 02 Apr 2010

Component Menu (XVW - Menu)

The XVW Menu component is a component used to create entries in a toolbar or a tree.

Example declaration of a Menu component (in a ToolBar):

<xvw:toolBar>
         <xvw:menu text="Export" toolTip="Export the form to HTML">
         </xvw:menu>
</xvw:toolBar>

A Menu can also include sub-menus (which can be used to create groups of items in tree components and in toolbars)

<xvw:menu text='XEO Models' expanded='true'>
     <xvw:menu
        icon='resources/Ebo_Package/ico16.gif'
        text='Packages' 
        value="{viewerName:'Ebo_Package_list.xvw', boql:'select Ebo_Package where deployed=\'1\''}" 
        target='Tab' 
        serverAction="#{viewBean.listObject}" 
      />

</xvw:menu>

The Menu component has the following properties

Property	Description	Type	Possivel values	Default value	Usage	Notes
text	The text to be shown as label of the menu	String/EL	Any string	None	Required
tooltip	The text to be presented as a tool tip (when mouse is over the menu)	String/EL	Any String	None	Optional
icon	Path to an icon to display next to the label	String/EL	Relative or Absolute path to an icon	None	Optional
iconCls	CSS class to apply to the icon(requires that the icon property is used)	String/EL	Nome da classe CSS	None	Optional
serverAction	Which action to execute in the server	Enum/EL	createObject, editObject, listObject, logout, openLink, openViewer or a user-defined action	None	Optional	Without this property the menu will do nothing. ( see serverActions)
target	Target in which the action will be executed	Enum	blank, window, tab, download, self, top	self	Optional	( see Targets table)
disabled	If the menu is disabled or not	Boolean	true / false	false	Optional
visible	If the menu is visible or not	Boolean	true / false	true	Optional
expanded	If the menu is expanded or not	Boolean	true / false	false	Optional	This option only works with nested menus
roles	List of coma-separated role names required to see/use this menu	String	Any valid role name	None	Optional	Only users in the roles assigned to this menu will have the ability to see/use it
workqueues	List of coma-separated workqueue names required to see/use this menu	String	Any valid workqueue name	None	Optional	See above
groups	List of coma-separated group names required to see/use this menu	String	Any valid group name	None	Optional	See above
profiles	List of coma-separated profile names required to see/use this menu	String	Any valid profile name	None	Optional	See above
profile	Name of the profile required to see/use this menu	String	Any valid profile name	None	Optional

Reference Tables

Server Actions : Default actions which can be invoked in the server.

Action	Description
createObject	Opens an edit viewer with a new object created??
editObject	Opens an edit viewer with a given object?
editObject(key, view)	Opens a given edit viewer for a given object?
listObject	Opens a List Viewer given a a BOQL expression
logout	Logout the current user
openLink	Opens a link in a new window
openViewer	Opens a given viewer

Targets: Which targets can be used for the server actions

Target	Description
blank	Opens content in a new Window
window	Opens content in a window inside the current tab
tab	Opens content in a new tab
self	Opens content in the same window/tab ( é o default)
top	Opens a new window that overlaps all frames
download	Forces the browser to show the Download dialog

Topic revision: r3 - 2010-05-29 - PedroRio

No permission to view TWiki.WebTopBar

No permission to view TWiki.WebBottomBar