com.xalys.xgl.menu

Class Menu

java.lang.Object

com.xalys.xgl.Widget<HTMLDivElement,Menu>

com.xalys.xgl.menu.Menu

All Implemented Interfaces:

EventTarget<Menu>, HasActionHandlers<Menu>, HasAnimationEndHandlers<Menu>, HasAnimationIterationHandlers<Menu>, HasAnimationStartHandlers<Menu>, HasAttachHandlers<Menu>, HasClickHandlers<Menu>, HasContextMenuHandlers<Menu>, HasDetachHandlers<Menu>, HasDoubleActionHandlers<Menu>, HasDoubleClickHandlers<Menu>, HasDoubleTapHandlers<Menu>, HasHandlers, HasKeyDownHandlers<Menu>, HasKeyHandlers<Menu>, HasKeyPressHandlers<Menu>, HasKeyUpHandlers<Menu>, HasMouseDownHandlers<Menu>, HasMouseHandlers<Menu>, HasMouseMoveHandlers<Menu>, HasMouseOutHandlers<Menu>, HasMouseOverHandlers<Menu>, HasMouseUpHandlers<Menu>, HasResizeHandlers<Menu>, HasScrollHandlers<Menu>, HasTapHandlers<Menu>, HasTouchCancelHandlers<Menu>, HasTouchEndHandlers<Menu>, HasTouchForceChangeHandlers<Menu>, HasTouchHandlers<Menu>, HasTouchHoldHandlers<Menu>, HasTouchMoveHandlers<Menu>, HasTouchStartHandlers<Menu>, HasTransitionEndHandlers<Menu>, HasWheelHandlers<Menu>, HasMenuCloseHandlers<Menu>, HasMenuShownHandlers<Menu>, ReflowScheduler<Menu>

public class Menu
extends Widget<HTMLDivElement,Menu>
implements HasMenuShownHandlers<Menu>, HasMenuCloseHandlers<Menu>

Author:

Paul Sitarz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Menu.Direction Direction is an enumeration that indicate in which way should the child menu open: to the right or to the left

Field Summary

Fields

Modifier and Type	Field and Description
protected ScrollablePanel	scrollablePanel

Fields inherited from class com.xalys.xgl.Widget

contextMenu, contextMenuHandlerRegistration, currentHeight, currentWidth, enabled, NATIVE_CONTEXT_MENU_HANDLER

Constructor Summary

Constructors

Constructor and Description
Menu()

Method Summary

Modifier and Type	Method and Description
void	add(AbstractMenuItem<?,?> menuItem)
Menu	add(Widget<?,?> widget)
HandlerRegistration	addMenuCloseHandler(MenuCloseHandler<Menu> menuCloseHandler)
HandlerRegistration	addMenuShownHandler(MenuShownHandler<Menu> menuShownHandler)
protected double	adjustScreenHeight(double screenHeight)
void	close() This method closes the menu shown and all children menus.
void	close(boolean cascade) This method allow to close all parent and child menu if the cascade parameter is true.
List<Widget<?,?>>	getChildren()
Menu.Direction	getDirection() Get the direction to which the child menu should open.
boolean	isDisplayed() Get the visiblity status of this menu, is it or not displayed?
Menu	remove(Widget<?,?> widget)
void	setDirection(Menu.Direction direction)
void	setPosition(Holder<Integer> x, Holder<Integer> top)
void	setPosition(int x, int top)
void	show()
protected void	updateBoundingBoxMeasure(double left, double top, double width, double height, double screenWidth, double screenHeight)
protected void	updateBoundingBoxMutation(double left, double top, double width, double height, double screenWidth, double screenHeight)

Methods inherited from class com.xalys.xgl.Widget

addActionHandler, addClassName, addDoubleActionHandler, addDoubleTapHandler, addDropTarget, addEventHandler, addEventHandler, addResizeHandler, addStyleName, addTapHandler, addTouchHoldHandler, canDropTargetAccept, cast, clear, clearBackgroundColor, clearDropTargets, clearTextColor, ensureHandlers, fireEvent, fireEvent, fireResizeEvent, getAbsoluteLeft, getAbsoluteTop, getAncestor, getChildrenCount, getComputedStyle, getContextMenu, getContextMenuHandler, getDeepestWidget, getDragSource, getDropTargetList, getElement, getFirstChild, getId, getLastChild, getNextSibling, getNextSibling, getOffsetHeight, getOffsetWidth, getParent, getScrollLeft, getScrollTop, getStyle, hasClassName, hasFocus, insert, isAttached, isDropTarget, isEnabled, isInEventThread, onAttach, onDetach, removeClassName, removeDropTarget, removeStyleName, setBackgroundColor, setClassName, setContextMenu, setDragSource, setDropTarget, setEnabled, setHeight, setHeight, setHeight, setId, setLeft, setLeftAndTop, setMaxHeight, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setMinWidth, setParent, setPixelSize, setScrollLeft, setScrollTop, setSize, setTextAlign, setTextColor, setTop, setWidth, setWidth, setWidth

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.xalys.xgl.events.HasHandlers

addEventHandler, addEventHandler

Methods inherited from interface com.xalys.xgl.presto.ReflowScheduler

cancelMeasure, cancelMutation, measureAsSoonAsPossible, mutateAsSoonAsPossible, mutateAsSoonAsPossible, scheduleMeasure, scheduleMutation

Methods inherited from interface com.xalys.xgl.events.HasAttachHandlers

addAttachHandler

Methods inherited from interface com.xalys.xgl.events.HasDetachHandlers

addDetachHandler

Methods inherited from interface com.xalys.xgl.events.HasTransitionEndHandlers

addTransitionEndHandler, addTransitionEndHandler

Methods inherited from interface com.xalys.xgl.events.HasMouseDownHandlers

addMouseDownHandler, addMouseDownHandler

Methods inherited from interface com.xalys.xgl.events.HasMouseMoveHandlers

addMouseMoveHandler, addMouseMoveHandler

Methods inherited from interface com.xalys.xgl.events.HasMouseOutHandlers

addMouseOutHandler, addMouseOutHandler

Methods inherited from interface com.xalys.xgl.events.HasMouseOverHandlers

addMouseOverHandler, addMouseOverHandler

Methods inherited from interface com.xalys.xgl.events.HasMouseUpHandlers

addMouseUpHandler, addMouseUpHandler

Methods inherited from interface com.xalys.xgl.events.HasWheelHandlers

addWheelHandler, addWheelHandler

Methods inherited from interface com.xalys.xgl.events.HasClickHandlers

addClickHandler, addClickHandler

Methods inherited from interface com.xalys.xgl.events.HasDoubleClickHandlers

addDoubleClickHandler, addDoubleClickHandler

Methods inherited from interface com.xalys.xgl.events.HasContextMenuHandlers

addContextMenuHandler, addContextMenuHandler

Methods inherited from interface com.xalys.xgl.events.HasTouchStartHandlers

addTouchStartHandler, addTouchStartHandler

Methods inherited from interface com.xalys.xgl.events.HasTouchMoveHandlers

addTouchMoveHandler, addTouchMoveHandler

Methods inherited from interface com.xalys.xgl.events.HasTouchForceChangeHandlers

addTouchForceChangeHandler, addTouchForceChangeHandler

Methods inherited from interface com.xalys.xgl.events.HasTouchEndHandlers

addTouchEndHandler, addTouchEndHandler

Methods inherited from interface com.xalys.xgl.events.HasTouchCancelHandlers

addTouchCancelHandler, addTouchCancelHandler

Methods inherited from interface com.xalys.xgl.events.HasTouchHoldHandlers

addTouchHoldHandler

Methods inherited from interface com.xalys.xgl.events.HasTapHandlers

addTapHandler

Methods inherited from interface com.xalys.xgl.events.HasDoubleTapHandlers

addDoubleTapHandler

Methods inherited from interface com.xalys.xgl.events.HasKeyDownHandlers

addKeyDownHandler, addKeyDownHandler

Methods inherited from interface com.xalys.xgl.events.HasKeyUpHandlers

addKeyUpHandler, addKeyUpHandler

Methods inherited from interface com.xalys.xgl.events.HasKeyPressHandlers

addKeyPressHandler, addKeyPressHandler

Methods inherited from interface com.xalys.xgl.events.HasScrollHandlers

addScrollHandler, addScrollHandler

Methods inherited from interface com.xalys.xgl.events.HasAnimationStartHandlers

addAnimationStartHandler, addAnimationStartHandler

Methods inherited from interface com.xalys.xgl.events.HasAnimationIterationHandlers

addAnimationIterationHandler, addAnimationIterationHandler

Methods inherited from interface com.xalys.xgl.events.HasAnimationEndHandlers

addAnimationEndHandler, addAnimationEndHandler

Methods inherited from interface com.xalys.xgl.events.HasActionHandlers

addActionHandler

Methods inherited from interface com.xalys.xgl.events.HasDoubleActionHandlers

addDoubleActionHandler

Field Detail

scrollablePanel

protected ScrollablePanel scrollablePanel

Constructor Detail

Menu

public Menu()

Method Detail

add

public Menu add(Widget<?,?> widget)

Overrides:

add in class Widget<HTMLDivElement,Menu>

add

public void add(AbstractMenuItem<?,?> menuItem)

getChildren

public List<Widget<?,?>> getChildren()

Overrides:

getChildren in class Widget<HTMLDivElement,Menu>

remove

public Menu remove(Widget<?,?> widget)

Overrides:

remove in class Widget<HTMLDivElement,Menu>

setPosition

public void setPosition(Holder<Integer> x,
                        Holder<Integer> top)

setPosition

public void setPosition(int x,
                        int top)

getDirection

public Menu.Direction getDirection()

Get the direction to which the child menu should open. To the right or to the left of the current menu. It is an hint only! If the child menu hit a border, it will switch direction.

Returns:

the direction

setDirection

public void setDirection(Menu.Direction direction)

Parameters:

direction - the direction to set

show

public void show()

updateBoundingBoxMeasure

@WillMeasure
protected void updateBoundingBoxMeasure(double left,
                                                     double top,
                                                     double width,
                                                     double height,
                                                     double screenWidth,
                                                     double screenHeight)

Parameters:

left -

top -

width -

height -

screenWidth -

screenHeight -

updateBoundingBoxMutation

@WillMutate
protected void updateBoundingBoxMutation(double left,
                                                     double top,
                                                     double width,
                                                     double height,
                                                     double screenWidth,
                                                     double screenHeight)

Parameters:

left -

top -

width -

height -

screenWidth -

screenHeight -

close

public void close(boolean cascade)

This method allow to close all parent and child menu if the cascade parameter is true. If the cascade parameter is false, then it is equivalent to calling the method close(), closing the current menu and all the children menus.

Parameters:

cascade - true if all the parent menu should be closed

close

public void close()

This method closes the menu shown and all children menus.

isDisplayed

public boolean isDisplayed()

Get the visiblity status of this menu, is it or not displayed?

Returns:

true if the menu is displayed, false if not

addMenuCloseHandler

public HandlerRegistration addMenuCloseHandler(MenuCloseHandler<Menu> menuCloseHandler)

Specified by:

addMenuCloseHandler in interface HasMenuCloseHandlers<Menu>

addMenuShownHandler

public HandlerRegistration addMenuShownHandler(MenuShownHandler<Menu> menuShownHandler)

Specified by:

addMenuShownHandler in interface HasMenuShownHandlers<Menu>

adjustScreenHeight

protected double adjustScreenHeight(double screenHeight)

Parameters:

screenHeight -

Returns: