|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.google.gwt.user.client.ui.UIObject com.google.gwt.user.client.ui.Widget com.google.gwt.user.client.ui.Panel com.google.gwt.user.client.ui.SimplePanel com.vaadin.terminal.gwt.client.ui.SimpleFocusablePanel com.vaadin.terminal.gwt.client.ui.menubar.VMenuBar
public class VMenuBar
Nested Class Summary | |
---|---|
static class |
VMenuBar.CustomMenuItem
A class to hold information on menu items |
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject |
---|
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled |
Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets |
---|
com.google.gwt.user.client.ui.HasWidgets.ForIsWidget |
Field Summary | |
---|---|
static String |
ATTRIBUTE_CHECKED
|
static String |
ATTRIBUTE_ITEM_DESCRIPTION
|
static String |
ATTRIBUTE_ITEM_DISABLED
|
static String |
ATTRIBUTE_ITEM_ICON
|
static String |
ATTRIBUTE_ITEM_STYLE
|
static String |
CLASSNAME
Set the CSS class name to allow styling. |
protected ApplicationConnection |
client
|
protected VMenuBar |
collapsedRootItems
|
protected com.google.gwt.user.client.Element |
containerElement
|
protected static com.google.gwt.user.client.Command |
emptyCommand
|
protected VMenuBar |
hostReference
|
static String |
HTML_CONTENT_ALLOWED
|
protected ArrayList<VMenuBar.CustomMenuItem> |
items
|
protected boolean |
menuVisible
|
protected VMenuBar.CustomMenuItem |
moreItem
|
static String |
OPEN_ROOT_MENU_ON_HOWER
|
protected VMenuBar |
parentMenu
|
protected VOverlay |
popup
|
protected VMenuBar.CustomMenuItem |
selected
|
protected boolean |
subMenu
Widget fields |
protected String |
uidlId
For server connections |
protected VMenuBar |
visibleChildMenu
|
Fields inherited from class com.google.gwt.user.client.ui.UIObject |
---|
DEBUG_ID_PREFIX |
Constructor Summary | |
---|---|
VMenuBar()
|
|
VMenuBar(boolean subMenu,
VMenuBar parentMenu)
|
Method Summary | |
---|---|
VMenuBar.CustomMenuItem |
addItem(String html,
com.google.gwt.user.client.Command cmd)
Add a new item to this menu |
void |
addItem(VMenuBar.CustomMenuItem item)
Add a new item to this menu |
void |
addItem(VMenuBar.CustomMenuItem item,
int index)
|
protected String |
buildItemHTML(UIDL item)
Build the HTML content for a menu item. |
void |
clearItems()
Remove all the items in this menu |
protected int |
getCloseMenuKey()
Get the key that closes the menu. |
com.google.gwt.user.client.Element |
getContainerElement()
Returns the containing element of the menu |
List<VMenuBar.CustomMenuItem> |
getItems()
Returns a list of items in this menu |
VMenuBar.CustomMenuItem |
getMenuItemWithElement(com.google.gwt.user.client.Element element)
Get menu item with given DOM element |
protected int |
getNavigationDownKey()
Get the key that moves the selection downwards. |
protected int |
getNavigationLeftKey()
Get the key that moves the selection left. |
protected int |
getNavigationRightKey()
Get the key that moves the selection right. |
protected int |
getNavigationSelectKey()
Get the key that selects a menu item. |
protected int |
getNavigationUpKey()
Get the key that moves the selection upwards. |
VMenuBar |
getParentMenu()
Returns the parent menu of this menu, or null if this is the top-level menu |
VMenuBar.CustomMenuItem |
getSelected()
Returns the currently selected item of this menu, or null if nothing is selected |
com.google.gwt.user.client.Element |
getSubPartElement(String subPart)
Locates an element inside a component using the identifier provided in subPart . |
String |
getSubPartName(com.google.gwt.user.client.Element subElement)
Provides an identifier that identifies the element within the component. |
boolean |
handleNavigation(int keycode,
boolean ctrl,
boolean shift)
Handles the keyboard events handled by the MenuBar |
void |
hideChildMenu(VMenuBar.CustomMenuItem item)
Hides the submenu of an item |
void |
hideChildren()
Recursively hide all child menus |
void |
hideParents(boolean autoClosed)
Recursively hide all parent menus |
void |
iLayout()
|
void |
iLayout(boolean iconLoadEvent)
|
void |
itemClick(VMenuBar.CustomMenuItem item)
When an item is clicked |
void |
itemOut(VMenuBar.CustomMenuItem item)
When the mouse is moved away from an item |
void |
itemOver(VMenuBar.CustomMenuItem item)
When the user hovers the mouse over the item |
void |
onBrowserEvent(com.google.gwt.user.client.Event e)
|
void |
onClose(com.google.gwt.event.logical.shared.CloseEvent<com.google.gwt.user.client.ui.PopupPanel> event)
Listener method, fired when this menu is closed |
protected void |
onDetach()
|
void |
onFocus(com.google.gwt.event.dom.client.FocusEvent event)
|
void |
onKeyDown(com.google.gwt.event.dom.client.KeyDownEvent event)
|
void |
onKeyPress(com.google.gwt.event.dom.client.KeyPressEvent event)
|
void |
onMenuClick(int clickedItemId)
This is called by the items in the menu and it communicates the information to the server |
void |
onShow()
When the menu is shown. |
void |
removeItem(VMenuBar.CustomMenuItem item)
Remove the given item from this menu |
void |
setParentMenu(VMenuBar parent)
Set the parent menu of this menu |
void |
setSelected(VMenuBar.CustomMenuItem item)
Set the currently selected item of this menu |
void |
showChildMenu(VMenuBar.CustomMenuItem item)
Shows the child menu of an item. |
protected void |
showChildMenuAt(VMenuBar.CustomMenuItem item,
int top,
int left)
|
Methods inherited from class com.vaadin.terminal.gwt.client.ui.SimpleFocusablePanel |
---|
addBlurHandler, addFocusHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, focus, setFocus, setTabIndex |
Methods inherited from class com.google.gwt.user.client.ui.SimplePanel |
---|
add, getWidget, iterator, remove, setWidget, setWidget |
Methods inherited from class com.google.gwt.user.client.ui.Panel |
---|
add, adopt, adopt, clear, disown, doAttachChildren, doDetachChildren, orphan, remove |
Methods inherited from class com.google.gwt.user.client.ui.Widget |
---|
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents |
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, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Field Detail |
---|
public static final String CLASSNAME
protected String uidlId
protected ApplicationConnection client
protected final VMenuBar hostReference
protected VMenuBar.CustomMenuItem moreItem
protected VMenuBar collapsedRootItems
protected static final com.google.gwt.user.client.Command emptyCommand
public static final String OPEN_ROOT_MENU_ON_HOWER
public static final String ATTRIBUTE_CHECKED
public static final String ATTRIBUTE_ITEM_DESCRIPTION
public static final String ATTRIBUTE_ITEM_ICON
public static final String ATTRIBUTE_ITEM_DISABLED
public static final String ATTRIBUTE_ITEM_STYLE
public static final String HTML_CONTENT_ALLOWED
protected boolean subMenu
protected ArrayList<VMenuBar.CustomMenuItem> items
protected com.google.gwt.user.client.Element containerElement
protected VOverlay popup
protected VMenuBar visibleChildMenu
protected boolean menuVisible
protected VMenuBar parentMenu
protected VMenuBar.CustomMenuItem selected
Constructor Detail |
---|
public VMenuBar()
public VMenuBar(boolean subMenu, VMenuBar parentMenu)
Method Detail |
---|
protected void onDetach()
onDetach
in class com.google.gwt.user.client.ui.Widget
protected String buildItemHTML(UIDL item)
item
-
public void onMenuClick(int clickedItemId)
clickedItemId
- id of the item that was clickedpublic List<VMenuBar.CustomMenuItem> getItems()
public void clearItems()
public com.google.gwt.user.client.Element getContainerElement()
getContainerElement
in class com.google.gwt.user.client.ui.SimplePanel
public VMenuBar.CustomMenuItem addItem(String html, com.google.gwt.user.client.Command cmd)
html
- items textcmd
- items command
public void addItem(VMenuBar.CustomMenuItem item)
item
- public void addItem(VMenuBar.CustomMenuItem item, int index)
public void removeItem(VMenuBar.CustomMenuItem item)
item
- public void onBrowserEvent(com.google.gwt.user.client.Event e)
onBrowserEvent
in interface com.google.gwt.user.client.EventListener
onBrowserEvent
in class com.google.gwt.user.client.ui.Widget
public void itemClick(VMenuBar.CustomMenuItem item)
item
- public void itemOver(VMenuBar.CustomMenuItem item)
item
- public void itemOut(VMenuBar.CustomMenuItem item)
item
- public void showChildMenu(VMenuBar.CustomMenuItem item)
item
- protected void showChildMenuAt(VMenuBar.CustomMenuItem item, int top, int left)
public void hideChildMenu(VMenuBar.CustomMenuItem item)
item
- public void onShow()
public void onClose(com.google.gwt.event.logical.shared.CloseEvent<com.google.gwt.user.client.ui.PopupPanel> event)
onClose
in interface com.google.gwt.event.logical.shared.CloseHandler<com.google.gwt.user.client.ui.PopupPanel>
public void hideChildren()
public void hideParents(boolean autoClosed)
public VMenuBar getParentMenu()
public void setParentMenu(VMenuBar parent)
parent
- public VMenuBar.CustomMenuItem getSelected()
public void setSelected(VMenuBar.CustomMenuItem item)
item
- public void iLayout()
public void iLayout(boolean iconLoadEvent)
public void onKeyPress(com.google.gwt.event.dom.client.KeyPressEvent event)
onKeyPress
in interface com.google.gwt.event.dom.client.KeyPressHandler
public void onKeyDown(com.google.gwt.event.dom.client.KeyDownEvent event)
onKeyDown
in interface com.google.gwt.event.dom.client.KeyDownHandler
protected int getNavigationUpKey()
protected int getNavigationDownKey()
protected int getNavigationLeftKey()
protected int getNavigationRightKey()
protected int getNavigationSelectKey()
protected int getCloseMenuKey()
public boolean handleNavigation(int keycode, boolean ctrl, boolean shift)
event
- The keyboard event received
public void onFocus(com.google.gwt.event.dom.client.FocusEvent event)
onFocus
in interface com.google.gwt.event.dom.client.FocusHandler
public com.google.gwt.user.client.Element getSubPartElement(String subPart)
SubPartAware
subPart
. The subPart
identifier is component specific and
may be any string of characters, numbers, space characters and brackets.
getSubPartElement
in interface SubPartAware
subPart
- The identifier for the element inside the component
public String getSubPartName(com.google.gwt.user.client.Element subElement)
SubPartAware
subElement
is a part of the component and must never be null.
Note!
getSubPartElement(getSubPartName(element)) == element
is not
always true. A component can choose to provide a more generic
identifier for any given element if the results of all interactions with
subElement
are 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 as subElement
because interactions with the DIV and the
root button element produce the same result.
getSubPartName
in interface SubPartAware
subElement
- The element the identifier string should uniquely identify
subElement
or null
if no identifier could be provided.public VMenuBar.CustomMenuItem getMenuItemWithElement(com.google.gwt.user.client.Element element)
element
- Element used in search
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |