Package com.vaadin.client.ui
Class VMenuBar.CustomMenuItem
- java.lang.Object
-
- com.google.gwt.user.client.ui.UIObject
-
- com.google.gwt.user.client.ui.Widget
-
- com.vaadin.client.ui.VMenuBar.CustomMenuItem
-
- All Implemented Interfaces:
com.google.gwt.event.logical.shared.HasAttachHandlers,com.google.gwt.event.shared.HasHandlers,com.google.gwt.user.client.EventListener,com.google.gwt.user.client.ui.HasHTML,com.google.gwt.user.client.ui.HasText,com.google.gwt.user.client.ui.HasVisibility,com.google.gwt.user.client.ui.IsWidget,SubPartAware
- Enclosing class:
- VMenuBar
public static class VMenuBar.CustomMenuItem extends com.google.gwt.user.client.ui.Widget implements com.google.gwt.user.client.ui.HasHTML, SubPartAware
A class to hold information on menu items.
-
-
Field Summary
Fields Modifier and Type Field Description protected booleancheckableprotected booleancheckedprotected com.google.gwt.user.client.Commandcommandprotected Stringdescriptionprotected ContentModedescriptionContentModeprotected booleanenabledprotected Stringhtmlprotected booleanisSeparatorprotected VMenuBarparentMenuprotected booleanselectedprotected VMenuBarsubMenu
-
Constructor Summary
Constructors Constructor Description CustomMenuItem()Default menu itemWidgetconstructor for GWT.create().CustomMenuItem(String html, com.google.gwt.user.client.Command cmd)Deprecated.use the default constructor andsetHTML(String)andsetCommand(Command)instead
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description com.google.gwt.user.client.CommandgetCommand()StringgetHTML()StringgetId()VMenuBargetParentMenu()VMenuBargetSubMenu()com.google.gwt.user.client.ElementgetSubPartElement(String subPart)Locates an element inside a component using the identifier provided insubPart.StringgetSubPartName(com.google.gwt.user.client.Element subElement)Provides an identifier that identifies the element within the component.StringgetText()TooltipInfogetTooltip()booleanisCheckable()booleanisChecked()booleanisEnabled()booleanisSelectable()Checks if the item can be selected.booleanisSeparator()voidonBrowserEvent(com.google.gwt.user.client.Event event)protected voidonLoad()voidsetCheckable(boolean checkable)voidsetChecked(boolean checked)voidsetCommand(com.google.gwt.user.client.Command command)voidsetDescription(String description)voidsetDescriptionContentMode(ContentMode descriptionContentMode)voidsetEnabled(boolean enabled)voidsetHTML(String html)voidsetId(String id)voidsetParentMenu(VMenuBar parentMenu)voidsetSelected(boolean selected)voidsetSeparator(boolean separator)voidsetStyleName(String style)voidsetSubMenu(VMenuBar subMenu)voidsetText(String text)voidupdateFromUIDL(UIDL uidl, ApplicationConnection client)voidupdateStyleNames()-
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onDetach, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents
-
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString
-
-
-
-
Field Detail
-
html
protected String html
-
command
protected com.google.gwt.user.client.Command command
-
subMenu
protected VMenuBar subMenu
-
parentMenu
protected VMenuBar parentMenu
-
enabled
protected boolean enabled
-
isSeparator
protected boolean isSeparator
-
checkable
protected boolean checkable
-
checked
protected boolean checked
-
selected
protected boolean selected
-
description
protected String description
-
descriptionContentMode
protected ContentMode descriptionContentMode
-
-
Constructor Detail
-
CustomMenuItem
public CustomMenuItem()
Default menu itemWidgetconstructor for GWT.create(). UsesetHTML(String)andsetCommand(Command)after constructing a menu item.
-
CustomMenuItem
@Deprecated public CustomMenuItem(String html, com.google.gwt.user.client.Command cmd)
Deprecated.use the default constructor andsetHTML(String)andsetCommand(Command)insteadCreates a menu itemWidget.- Parameters:
html-cmd-
-
-
Method Detail
-
onBrowserEvent
public void onBrowserEvent(com.google.gwt.user.client.Event event)
- Specified by:
onBrowserEventin interfacecom.google.gwt.user.client.EventListener- Overrides:
onBrowserEventin classcom.google.gwt.user.client.ui.Widget
-
onLoad
protected void onLoad()
- Overrides:
onLoadin classcom.google.gwt.user.client.ui.Widget
-
setStyleName
public void setStyleName(String style)
- Overrides:
setStyleNamein classcom.google.gwt.user.client.ui.UIObject
-
setSelected
public void setSelected(boolean selected)
-
setChecked
public void setChecked(boolean checked)
-
isChecked
public boolean isChecked()
-
setCheckable
public void setCheckable(boolean checkable)
-
isCheckable
public boolean isCheckable()
-
setSubMenu
public void setSubMenu(VMenuBar subMenu)
-
getSubMenu
public VMenuBar getSubMenu()
-
setParentMenu
public void setParentMenu(VMenuBar parentMenu)
-
updateStyleNames
public void updateStyleNames()
-
getParentMenu
public VMenuBar getParentMenu()
-
setCommand
public void setCommand(com.google.gwt.user.client.Command command)
-
getCommand
public com.google.gwt.user.client.Command getCommand()
-
getHTML
public String getHTML()
- Specified by:
getHTMLin interfacecom.google.gwt.user.client.ui.HasHTML
-
setHTML
public void setHTML(String html)
- Specified by:
setHTMLin interfacecom.google.gwt.user.client.ui.HasHTML
-
getText
public String getText()
- Specified by:
getTextin interfacecom.google.gwt.user.client.ui.HasText
-
setText
public void setText(String text)
- Specified by:
setTextin interfacecom.google.gwt.user.client.ui.HasText
-
setEnabled
public void setEnabled(boolean enabled)
-
isEnabled
public boolean isEnabled()
-
setSeparator
public void setSeparator(boolean separator)
-
isSeparator
public boolean isSeparator()
-
updateFromUIDL
public void updateFromUIDL(UIDL uidl, ApplicationConnection client)
-
getTooltip
public TooltipInfo getTooltip()
-
isSelectable
public boolean isSelectable()
Checks if the item can be selected.- Returns:
- true if it is possible to select this item, false otherwise
-
getSubPartElement
public com.google.gwt.user.client.Element getSubPartElement(String subPart)
Description copied from interface:SubPartAwareLocates an element inside a component using the identifier provided insubPart. ThesubPartidentifier is component specific and may be any string of characters, numbers, space characters and brackets.- Specified by:
getSubPartElementin interfaceSubPartAware- Parameters:
subPart- The identifier for the element inside the component- Returns:
- The element identified by subPart or null if the element could not be found.
-
getSubPartName
public String getSubPartName(com.google.gwt.user.client.Element subElement)
Description copied from interface:SubPartAwareProvides an identifier that identifies the element within the component. ThesubElementis a part of the component and must never be null.Note!
getSubPartElement(getSubPartName(element)) == elementis not always true. A component can choose to provide a more generic identifier for any given element if the results of all interactions withsubElementare the same as interactions with the element identified by the return value. For example a button can return an identifier for the root element even though a DIV inside the button was passed assubElementbecause interactions with the DIV and the root button element produce the same result.- Specified by:
getSubPartNamein interfaceSubPartAware- Parameters:
subElement- The element the identifier string should uniquely identify- Returns:
- An identifier that uniquely identifies
subElementor null if no identifier could be provided.
-
getId
public String getId()
-
setId
public void setId(String id)
-
setDescription
public void setDescription(String description)
-
setDescriptionContentMode
public void setDescriptionContentMode(ContentMode descriptionContentMode)
-
-