|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.smartgwt.client.core.JsObject
com.smartgwt.client.core.DataClass
com.smartgwt.client.core.RefDataClass
com.smartgwt.client.data.Record
com.smartgwt.client.widgets.grid.ListGridRecord
com.smartgwt.client.widgets.menu.MenuItem
public class MenuItem
Menu items are specified are object literals, not class instances. For example, when developing in JavaScript, a typical initialization block for a Menu would look like this:
Menu.create({ data: [ {title: "item1", click: "alert(1)"}, {title: "item2"} ] });And in XML:
<Menu> <data> <MenuItem title="item1" click="alert(1)"/> <MenuItem title="item2"/> </data> </Menu>
Field Summary |
---|
Fields inherited from class com.smartgwt.client.core.JsObject |
---|
jsObj |
Constructor Summary | |
---|---|
MenuItem()
|
|
MenuItem(com.google.gwt.core.client.JavaScriptObject jsObj)
|
|
MenuItem(java.lang.String title)
|
|
MenuItem(java.lang.String title,
java.lang.String icon)
|
|
MenuItem(java.lang.String title,
java.lang.String icon,
java.lang.String keyTitle)
|
Method Summary | |
---|---|
HandlerRegistration |
addClickHandler(ClickHandler handler)
Add a click handler. |
java.lang.Boolean |
checkIf(Canvas target,
Menu menu,
MenuItem item)
Contains the condition that will check or uncheck the curent menuItem. |
java.lang.Boolean |
enableIf(Canvas target,
Menu menu,
MenuItem item)
Contains the condition that will enable or disable the curent menuItem. |
java.lang.Boolean |
getCanSelectParent()
A MenuItem that has a submenu normally cannot be selected, instead clicking or hitting Enter while keyboard focus is on the item shows the submenu. |
java.lang.Boolean |
getChecked()
If true, this item displays a standard checkmark image to the left of its title. |
java.lang.Boolean |
getEnabled()
Affects the visual style and interactivity of the menu item. |
java.lang.String |
getIcon()
The base filename for this item's custom icon. |
int |
getIconHeight()
The height applied to this item's icon. |
int |
getIconWidth()
The width applied to this item's icon. |
java.lang.Boolean |
getIsSeparator()
When set to true , this menu item shows a horizontal separator instead of
the title text. |
java.lang.String |
getKeyTitle()
A string to display in the shortcut-key column for this item. |
static MenuItem |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
|
Menu |
getSubmenu()
A reference to another menu, to display as a submenu when the mouse cursor hovers over this menu item. |
java.lang.String |
getTitle()
The text displayed for the menu item |
void |
setCanSelectParent(java.lang.Boolean canSelectParent)
A MenuItem that has a submenu normally cannot be selected, instead clicking or hitting Enter while keyboard focus is on the item shows the submenu. |
void |
setChecked(java.lang.Boolean checked)
If true, this item displays a standard checkmark image to the left of its title. |
void |
setCheckIfCondition(MenuItemIfFunction checkIf)
Contains the condition that will check or uncheck the curent menuItem. |
void |
setDynamicIconFunction(MenuItemStringFunction handler)
Contains the condition that will change the curent items' icon when met. |
void |
setDynamicTitleFunction(MenuItemStringFunction handler)
Contains the condition that will change the curent items' title when met. |
void |
setEnabled(java.lang.Boolean enabled)
Affects the visual style and interactivity of the menu item. |
void |
setEnableIfCondition(MenuItemIfFunction enableIf)
Contains the condition that will enable or disable the curent menuItem. |
void |
setIcon(java.lang.String icon)
The base filename for this item's custom icon. |
void |
setIconHeight(int iconHeight)
The height applied to this item's icon. |
void |
setIconWidth(int iconWidth)
The width applied to this item's icon. |
void |
setIsSeparator(java.lang.Boolean isSeparator)
When set to true , this menu item shows a horizontal separator instead of
the title text. |
void |
setKeys(KeyIdentifier... keys)
Shortcut key(s) to fire the menu item action. |
void |
setKeys(java.lang.String... keys)
Shortcut key(s) to fire the menu item action. |
void |
setKeyTitle(java.lang.String keyTitle)
A string to display in the shortcut-key column for this item. |
void |
setSubmenu(Menu submenu)
A reference to another menu, to display as a submenu when the mouse cursor hovers over this menu item. |
void |
setTitle(java.lang.String title)
The text displayed for the menu item |
Methods inherited from class com.smartgwt.client.widgets.grid.ListGridRecord |
---|
getCanAcceptDrop, getCanDrag, getLinkText, getSingleCellValue, setCanAcceptDrop, setCanDrag, setLinkText, setSingleCellValue |
Methods inherited from class com.smartgwt.client.data.Record |
---|
convertToRecordArray |
Methods inherited from class com.smartgwt.client.core.RefDataClass |
---|
getRef, getRef |
Methods inherited from class com.smartgwt.client.core.JsObject |
---|
isCreated, setJsObj |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Constructor Detail |
---|
public MenuItem()
public MenuItem(com.google.gwt.core.client.JavaScriptObject jsObj)
public MenuItem(java.lang.String title)
public MenuItem(java.lang.String title, java.lang.String icon)
public MenuItem(java.lang.String title, java.lang.String icon, java.lang.String keyTitle)
Method Detail |
---|
public static MenuItem getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public void setTitle(java.lang.String title)
title
- title Default value is nullpublic java.lang.String getTitle()
public void setSubmenu(Menu submenu)
submenu
- submenu Default value is nullpublic Menu getSubmenu()
public void setCanSelectParent(java.lang.Boolean canSelectParent)
canSelectParent
- canSelectParent Default value is nullpublic java.lang.Boolean getCanSelectParent()
public void setIsSeparator(java.lang.Boolean isSeparator)
true
, this menu item shows a horizontal separator instead of
the title
text. Typically specified as the only property of a menu item,
since the separator will not respond to mouse events.
setIsSeparator
in class ListGridRecord
isSeparator
- isSeparator Default value is falsepublic java.lang.Boolean getIsSeparator()
true
, this menu item shows a horizontal separator instead of
the title
text. Typically specified as the only property of a menu item,
since the separator will not respond to mouse events.
getIsSeparator
in class ListGridRecord
public void setEnabled(java.lang.Boolean enabled)
false
, the menu item will not respond to mouse rollovers or clicks.
If you need to set this state dynamically, use enableIf(com.smartgwt.client.widgets.Canvas, com.smartgwt.client.widgets.menu.Menu, com.smartgwt.client.widgets.menu.MenuItem)
instead.
setEnabled
in class ListGridRecord
enabled
- enabled Default value is truepublic java.lang.Boolean getEnabled()
false
, the menu item will not respond to mouse rollovers or clicks.
If you need to set this state dynamically, use enableIf(com.smartgwt.client.widgets.Canvas, com.smartgwt.client.widgets.menu.Menu, com.smartgwt.client.widgets.menu.MenuItem)
instead.
getEnabled
in class ListGridRecord
public void setChecked(java.lang.Boolean checked)
checkmarkImage
.
If you need to set this state dynamically, use checkIf(com.smartgwt.client.widgets.Canvas, com.smartgwt.client.widgets.menu.Menu, com.smartgwt.client.widgets.menu.MenuItem)
instead.
checked
- checked Default value is nullpublic java.lang.Boolean getChecked()
checkmarkImage
.
If you need to set this state dynamically, use checkIf(com.smartgwt.client.widgets.Canvas, com.smartgwt.client.widgets.menu.Menu, com.smartgwt.client.widgets.menu.MenuItem)
instead.
public void setIcon(java.lang.String icon)
checked
are both specified, only icon specified by this property will be
displayed. The path to the loaded skin directory and the skinImgDir are prepended to
this filename to form the full URL.
If you need to set this state dynamically, use com.smartgwt.client.widgets.menu.MenuItem#dynamicIcon
instead.
icon
- icon Default value is nullpublic java.lang.String getIcon()
checked
are both specified, only icon specified by this property will be
displayed. The path to the loaded skin directory and the skinImgDir are prepended to
this filename to form the full URL.
If you need to set this state dynamically, use com.smartgwt.client.widgets.menu.MenuItem#dynamicIcon
instead.
public void setIconWidth(int iconWidth)
16
can be changed
for all MenuItems by overriding iconWidth
.
iconWidth
- iconWidth Default value is 16public int getIconWidth()
16
can be changed
for all MenuItems by overriding iconWidth
.
public void setIconHeight(int iconHeight)
16
can be changed
for all MenuItems by overriding iconHeight
.
iconHeight
- iconHeight Default value is 16public int getIconHeight()
16
can be changed
for all MenuItems by overriding iconHeight
.
public void setKeyTitle(java.lang.String keyTitle)
keys
will be used by default.
keyTitle
- keyTitle Default value is see belowpublic java.lang.String getKeyTitle()
keys
will be used by default.
public java.lang.Boolean enableIf(Canvas target, Menu menu, MenuItem item)
If you don't need to set this state dynamically, use enabled
instead.
May be defined as a 'stringMethod'
.
target
- target
attribute for the top level menu.menu
- Menu
contains the reference to the menu that contains the current itemitem
- contains the reference to the current item
public java.lang.Boolean checkIf(Canvas target, Menu menu, MenuItem item)
If you don't need to set this state dynamically, use checked
instead.
May be defined as a 'stringMethod'
.
target
- target
attribute for the top level menu.menu
- Menu
contains the reference to the menu that contains the current itemitem
- contains the reference to the current item
public HandlerRegistration addClickHandler(ClickHandler handler)
Executed when this menu item is clicked by the user. The click handler must be specified
as a function or string of script. Return false to suppress the Menu.addItemClickHandler(com.smartgwt.client.widgets.menu.events.ItemClickHandler)
handler if specified.
addClickHandler
in interface HasClickHandlers
handler
- the click handler
HandlerRegistration
used to remove this handlerpublic void setKeys(java.lang.String... keys)
KeyIdentifier
.
To apply multiple shortcut keys to this item, set this property to an array of such key identifiers.
keys
- keys Default value is nullpublic void setKeys(KeyIdentifier... keys)
KeyIdentifier
.
To apply multiple shortcut keys to this item, set this property to an array of such key identifiers.
keys
- keys Default value is nullpublic void setEnableIfCondition(MenuItemIfFunction enableIf)
If you don't need to
set this state dynamically, use enabled
instead.
public void setCheckIfCondition(MenuItemIfFunction checkIf)
If you don't need to
set this state dynamically, use checked
instead.
public void setDynamicTitleFunction(MenuItemStringFunction handler)
If you don't need to set this state dynamically, use title
instead.
public void setDynamicIconFunction(MenuItemStringFunction handler)
If you don't need to set this state dynamically, use icon
instead.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |