com.xalys.xgl

Class Widget<E extends Element<E>,W extends Widget<E,W>>

java.lang.Object

com.xalys.xgl.Widget<E,W>

Type Parameters:

E -

W -

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractComboBox.InputWidget, AbstractDialog, AbstractDialog.Backdrop, AbstractDialog.Container, AbstractHeader, AbstractHeader.TitleWidget, AbstractImage, AbstractMenuItem, AbstractNamedPanel, AbstractNamedPanel.Body, AbstractNamedPanel.BodyRow, AbstractNamedPanel.HeaderRow, AbstractNamedPanel.Icon, AbstractNamedPanel.Title, AbstractRow, AbstractUse, AbstractWebGLCanvas, AbstractWindow, Anchor, BodyTable, BorderLayoutPanel, BrowserWindow, Button, ButtonGroup, Canvas, Card, Chart, Circle, ClipPath, CloseIcon, Column, ColumnContainer, ColumnHeaderCell, ContentPanel, ContentPanel.Body, CssClassHeaderIcon, DataRow, DatePickerPanel, Defs, Desc, Desktop, DesktopMenuBar, DesktopViewport, DialogFooter, Dock, Dock.IconWrapper, Ellipse, FeBlend, FeColorMatrix, FeGaussianBlur, FeOffset, FieldLabel, FieldSet, FieldSet.Body, FieldSet.BodyRow, FieldSet.HeaderRow, FieldSet.Icon, FieldSet.Title, Filter, FitContainer, FocusableWidget, FormPanel, FormPanel.FormPanelBody, Group, Handle, HeaderButtonBar, HeaderCell, HorizontalDragger, HorizontalScrollBar, HTMLHeader, Icon, ImageCard, ImageHeaderIcon, Label, LinearGradient, Link, MaterialHeaderIcon, Menu, MenuBar, MenuCell, NavBar, NavBarMenu, NavBarMenuItem, NavButton, Panel, Paragraph, Path, Radio, Rect, ResizeIndicator, ResizeTracker, ResizeTracker, ResponsivePanel, ResponsivePanel.PanelBody, RowContainer, ScrollablePanel, Slider, SliderBar, Stop, SVG, Symbol, TabBarIcon, TabBody, TabHeader, TabHeaderBar, Table, TabPanel, TabPanelBody, TabsBar, TabsBarWrapper, Terminal, Text, Toast, Toolbar, Tree, Tree.ContentPanel, TSpan, VerticalDragger, VerticalScrollBar, Viewport, WindowContent, WindowFooter, WindowGlass

@JsType(namespace="xgl")
public abstract class Widget<E extends Element<E>,W extends Widget<E,W>>
extends Object
implements HasHandlers, ReflowScheduler<W>, EventTarget<W>, HasAttachHandlers<W>, HasDetachHandlers<W>, HasTransitionEndHandlers<W>, HasMouseHandlers<W>, HasTouchHandlers<W>, HasKeyHandlers<W>, HasScrollHandlers<W>, HasAnimationStartHandlers<W>, HasAnimationIterationHandlers<W>, HasAnimationEndHandlers<W>, HasActionHandlers<W>, HasDoubleActionHandlers<W>, HasResizeHandlers<W>

Author:

Paul Sitarz

Field Summary

Fields

Modifier and Type	Field and Description
protected Menu	contextMenu
protected HandlerRegistration	contextMenuHandlerRegistration
protected Double	currentHeight
protected Double	currentWidth
protected boolean	enabled
protected static EventListener<? extends NativeEvent<?>>	NATIVE_CONTEXT_MENU_HANDLER

Constructor Summary

Constructors

Constructor and Description
Widget(E element)

Method Summary

Modifier and Type	Method and Description
W	add(Widget<? extends Element<?>,?> widget)
HandlerRegistration	addActionHandler(ActionHandler<W> actionHandler, EventPhase eventPhase)
W	addClassName(String cssClassName)
HandlerRegistration	addDoubleActionHandler(DoubleActionHandler<W> doubleActionHandler, EventPhase eventPhase)
HandlerRegistration	addDoubleTapHandler(DoubleTapHandler<W> doubleTapHandler, EventPhase eventPhase)
W	addDropTarget(DropTarget<W,?,?> dropTarget)
<H extends EventHandler> HandlerRegistration	addEventHandler(H handler, Event.Type<H> type)
<H extends EventHandler> HandlerRegistration	addEventHandler(H handler, Event.Type<H> type, EventPhase phase)
HandlerRegistration	addResizeHandler(ResizeHandler<W> resizeHandler)
W	addStyleName(String cssClassName)
HandlerRegistration	addTapHandler(TapHandler<W> tapHandler, EventPhase eventPhase)
HandlerRegistration	addTouchHoldHandler(TouchHoldHandler<W> touchHandler, EventPhase eventPhase)
boolean	canDropTargetAccept()
<T> T	cast()
W	clear()
W	clearBackgroundColor() Clears the background color, the theme's background color will be used.
W	clearDropTargets()
W	clearTextColor() Clears the text color, the theme's color will be used.
protected HandlerManager<E,W>	ensureHandlers()
protected <H extends EventHandler> void	fireEvent(Event<H> event)
protected <H extends EventHandler> void	fireEvent(Event<H> event, EventPhase eventPhase)
protected void	fireResizeEvent()
int	getAbsoluteLeft()
int	getAbsoluteTop()
Widget<?,?>	getAncestor(int level)
List<Widget<?,?>>	getChildren()
int	getChildrenCount()
ComputedStyle	getComputedStyle()
Menu	getContextMenu()
protected ContextMenuHandler<W>	getContextMenuHandler()
Widget<?,?>	getDeepestWidget(Element<?> element) Returns the deepest widget for which the submitted element is wrapped by the widget or is in the widget hierarchy, provided there is no widget wrapping the submitted element and there is no widget deeper in the tree.
DragSource<W,?>	getDragSource()
Set<DropTarget<W,?,?>>	getDropTargetList()
E	getElement()
<T extends Widget<?,?>> T	getFirstChild()
String	getId()
<T extends Widget<?,?>> T	getLastChild()
Widget<?,?>	getNextSibling()
Widget<?,?>	getNextSibling(Widget<?,?> widget)
double	getOffsetHeight()
double	getOffsetWidth()
Widget<?,?>	getParent()
int	getScrollLeft()
int	getScrollTop()
MutableStyle	getStyle()
boolean	hasClassName(String cssClassName)
boolean	hasFocus()
void	insert(Widget<? extends Element<?>,?> widget, Widget<? extends Element<?>,?> beforeWidget)
boolean	isAttached()
boolean	isDropTarget() If the widget has any drop target set, then it is a valid drop target
boolean	isEnabled()
static boolean	isInEventThread()
protected void	onAttach()
protected void	onDetach()
W	remove(Widget<?,?> widget)
W	removeClassName(String cssClassName)
W	removeDropTarget(DropTarget<W,?,?> dropTarget)
W	removeStyleName(String cssClassName) Alias for removeClass
W	setBackgroundColor(Color backgroundColor) Set the background color.
W	setClassName(String cssClassName)
W	setContextMenu(Menu contextMenu)
W	setDragSource(DragSource<W,?> dragSource)
W	setDropTarget(DropTarget<W,?,?>... dropTargets)
W	setEnabled(boolean enabled)
W	setHeight(Calc height)
W	setHeight(double height)
W	setHeight(double height, Unit unit)
void	setId(String id)
W	setLeft(double left)
W	setLeftAndTop(double left, double top)
W	setMaxHeight(Calc height)
W	setMaxHeight(double height)
W	setMaxHeight(double height, Unit unit)
W	setMaxWidth(Calc width)
W	setMaxWidth(double width)
W	setMaxWidth(double width, Unit unit)
W	setMinHeight(Calc height)
W	setMinHeight(double height)
W	setMinHeight(double height, Unit unit)
W	setMinWidth(Calc width)
W	setMinWidth(double width)
W	setMinWidth(double width, Unit unit)
protected void	setParent(Widget<?,?> parent)
W	setPixelSize(int width, int height)
W	setScrollLeft(int scrollLeft)
W	setScrollTop(int scrollTop)
W	setSize(double width, double height)
W	setTextAlign(TextAlign textAlign) Set the text alignment.
W	setTextColor(Color textColor) Set the text color.
W	setTop(double top)
W	setWidth(Calc width)
W	setWidth(double width)
W	setWidth(double width, Unit unit)

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.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

contextMenu

protected Menu contextMenu

contextMenuHandlerRegistration

protected HandlerRegistration contextMenuHandlerRegistration

enabled

protected boolean enabled

NATIVE_CONTEXT_MENU_HANDLER

protected static final EventListener<? extends NativeEvent<?>> NATIVE_CONTEXT_MENU_HANDLER

currentWidth

protected Double currentWidth

currentHeight

protected Double currentHeight

Constructor Detail

Widget

public Widget(E element)

Method Detail

getElement

public E getElement()

addEventHandler

@JsIgnore
public final <H extends EventHandler> HandlerRegistration addEventHandler(H handler,
                                                                                    Event.Type<H> type)

Specified by:

addEventHandler in interface HasHandlers

addEventHandler

public final <H extends EventHandler> HandlerRegistration addEventHandler(H handler,
                                                                          Event.Type<H> type,
                                                                          EventPhase phase)

Specified by:

addEventHandler in interface HasHandlers

ensureHandlers

protected HandlerManager<E,W> ensureHandlers()

getParent

public Widget<?,?> getParent()

getAncestor

public Widget<?,?> getAncestor(int level)

getChildrenCount

public int getChildrenCount()

getChildren

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

getFirstChild

public <T extends Widget<?,?>> T getFirstChild()

getLastChild

public <T extends Widget<?,?>> T getLastChild()

setParent

protected void setParent(Widget<?,?> parent)

insert

public void insert(Widget<? extends Element<?>,?> widget,
                   Widget<? extends Element<?>,?> beforeWidget)

add

@WillMutate
public W add(Widget<? extends Element<?>,?> widget)

onAttach

protected void onAttach()

onDetach

protected void onDetach()

isAttached

public boolean isAttached()

cast

public <T> T cast()

remove

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

getId

public String getId()

setId

public void setId(String id)

hasFocus

public boolean hasFocus()

hasClassName

public boolean hasClassName(String cssClassName)

setClassName

@WillMutate
public W setClassName(String cssClassName)

addClassName

@WillMutate
public W addClassName(String cssClassName)

addStyleName

public W addStyleName(String cssClassName)

removeClassName

@WillMutate
public W removeClassName(String cssClassName)

removeStyleName

@WillMutate
public W removeStyleName(String cssClassName)

Alias for removeClass

Parameters:

cssClassName - the class name to remove

Returns:

this widget (for daisy chaining)

getStyle

public MutableStyle getStyle()

getComputedStyle

public ComputedStyle getComputedStyle()

getAbsoluteLeft

public int getAbsoluteLeft()

getAbsoluteTop

public int getAbsoluteTop()

fireEvent

protected <H extends EventHandler> void fireEvent(Event<H> event)

fireEvent

protected <H extends EventHandler> void fireEvent(Event<H> event,
                                                  EventPhase eventPhase)

getOffsetWidth

public double getOffsetWidth()

getOffsetHeight

public double getOffsetHeight()

setLeft

public W setLeft(double left)

setTop

public W setTop(double top)

setSize

@JsIgnore
public W setSize(double width,
                           double height)

setLeftAndTop

public W setLeftAndTop(double left,
                       double top)

setPixelSize

public W setPixelSize(int width,
                      int height)

clear

public W clear()

setWidth

@JsMethod(name="setCalcWidth")
public W setWidth(Calc width)

setWidth

@JsMethod(name="setPixelWidth")
public W setWidth(double width)

setHeight

@JsMethod(name="setCalcHeight")
public W setHeight(Calc height)

setHeight

@JsMethod(name="setPixelHeight")
public W setHeight(double height)

setWidth

@JsMethod
public W setWidth(double width,
                            Unit unit)

setHeight

public W setHeight(double height,
                   @JsOptional
                   Unit unit)

setMinWidth

@JsMethod(name="setCalcMinWidth")
public W setMinWidth(Calc width)

setMinWidth

@JsMethod(name="setPixelMinWidth")
public W setMinWidth(double width)

setMinHeight

@JsMethod(name="setCalcMinHeight")
public W setMinHeight(Calc height)

setMinHeight

@JsMethod(name="setPixelMinHeight")
public W setMinHeight(double height)

setMinWidth

public W setMinWidth(double width,
                     @JsOptional
                     Unit unit)

setMinHeight

public W setMinHeight(double height,
                      @JsOptional
                      Unit unit)

setMaxWidth

@JsMethod(name="setCalcMaxWidth")
public W setMaxWidth(Calc width)

setMaxWidth

@JsMethod(name="setPixelMaxWidth")
public W setMaxWidth(double width)

setMaxHeight

@JsMethod(name="setCalcMaxHeight")
public W setMaxHeight(Calc height)

setMaxHeight

@JsMethod(name="setPixelMaxHeight")
public W setMaxHeight(double height)

setMaxWidth

public W setMaxWidth(double width,
                     @JsOptional
                     Unit unit)

setMaxHeight

public W setMaxHeight(double height,
                      @JsOptional
                      Unit unit)

getNextSibling

@JsIgnore
public Widget<?,?> getNextSibling()

Returns:

the next XGL sibbling, null if there is no such sibling

getNextSibling

@JsIgnore
public Widget<?,?> getNextSibling(Widget<?,?> widget)

Parameters:

widget - The widget for which you want to find the next XGL sibling. It has to be a child of the current widget.

Returns:

the next XGL sibling of the widget given in parameter, null if there is no such sibling

clearTextColor

public W clearTextColor()

Clears the text color, the theme's color will be used.

Returns:

this widget (for daisy chaining)

setTextAlign

public W setTextAlign(TextAlign textAlign)

Set the text alignment. If the text alignment is null, acts like #clearTextAlign(), the theme's text alignment will be used.

Parameters:

textAlign - the alignment used for the text of this widget. If the alignment is null, revert to the theme's text alignment.

Returns:

this widget

setTextColor

public W setTextColor(Color textColor)

Set the text color. If the color is null, acts like clearTextColor(), the theme's text color will be used.

Parameters:

textColor - the color used for the text of this widget. If the color is null, revert to the theme's text color.

Returns:

this widget

clearBackgroundColor

public W clearBackgroundColor()

Clears the background color, the theme's background color will be used.

Returns:

this widget (for daisy chaining)

setBackgroundColor

public W setBackgroundColor(Color backgroundColor)

Set the background color. If the color is null, acts like clearBackgroundColor(), the theme's background color will be used.

Parameters:

backgroundColor - the background color to set

Returns:

(for daisy chaining)

addTapHandler

public HandlerRegistration addTapHandler(TapHandler<W> tapHandler,
                                         EventPhase eventPhase)

Specified by:

addTapHandler in interface HasTapHandlers<W extends Widget<E,W>>

addDoubleTapHandler

public HandlerRegistration addDoubleTapHandler(DoubleTapHandler<W> doubleTapHandler,
                                               EventPhase eventPhase)

Specified by:

addDoubleTapHandler in interface HasDoubleTapHandlers<W extends Widget<E,W>>

addTouchHoldHandler

@JsIgnore
public HandlerRegistration addTouchHoldHandler(TouchHoldHandler<W> touchHandler,
                                                         EventPhase eventPhase)

Specified by:

addTouchHoldHandler in interface HasTouchHoldHandlers<W extends Widget<E,W>>

getContextMenuHandler

protected ContextMenuHandler<W> getContextMenuHandler()

isEnabled

public boolean isEnabled()

setEnabled

public W setEnabled(boolean enabled)

setContextMenu

public W setContextMenu(Menu contextMenu)

Parameters:

contextMenu - the contextMenu to set

Returns:

this widget (for daisy chaining)

getContextMenu

public Menu getContextMenu()

Returns:

the contextMenu

addActionHandler

@JsIgnore
public HandlerRegistration addActionHandler(ActionHandler<W> actionHandler,
                                                      EventPhase eventPhase)

Specified by:

addActionHandler in interface HasActionHandlers<W extends Widget<E,W>>

addDoubleActionHandler

@JsIgnore
public HandlerRegistration addDoubleActionHandler(DoubleActionHandler<W> doubleActionHandler,
                                                            EventPhase eventPhase)

Specified by:

addDoubleActionHandler in interface HasDoubleActionHandlers<W extends Widget<E,W>>

setDragSource

public W setDragSource(DragSource<W,?> dragSource)

Parameters:

dragSource - the dragSource to set

setDropTarget

public W setDropTarget(DropTarget<W,?,?>... dropTargets)

Parameters:

dropTargets - the dropTargets to set

addDropTarget

public W addDropTarget(DropTarget<W,?,?> dropTarget)

Parameters:

dropTarget - the dropTarget to set

removeDropTarget

public W removeDropTarget(DropTarget<W,?,?> dropTarget)

Parameters:

dropTarget - the dropTarget to remove

clearDropTargets

public W clearDropTargets()

isDropTarget

public boolean isDropTarget()

If the widget has any drop target set, then it is a valid drop target

Returns:

true if the widget is a drop target

getDragSource

public DragSource<W,?> getDragSource()

Returns:

the dragSource

getDropTargetList

public Set<DropTarget<W,?,?>> getDropTargetList()

Returns:

the dropTarget

canDropTargetAccept

public boolean canDropTargetAccept()

getDeepestWidget

public Widget<?,?> getDeepestWidget(Element<?> element)

Returns the deepest widget for which the submitted element is wrapped by the widget or is in the widget hierarchy, provided there is no widget wrapping the submitted element and there is no widget deeper in the tree. This method is usually useful when doing a drag and drop: in order to find the widget being the drop target, call it on the Viewport widget.

Parameters:

element - the element for which

Returns:

the deepest widget in the tree containing the submitted element.

fireResizeEvent

@WillMeasure
protected void fireResizeEvent()

addResizeHandler

public HandlerRegistration addResizeHandler(ResizeHandler<W> resizeHandler)

Specified by:

addResizeHandler in interface HasResizeHandlers<W extends Widget<E,W>>

getScrollLeft

@WillMeasure
public int getScrollLeft()

Returns:

setScrollLeft

@WillMutate
public W setScrollLeft(int scrollLeft)

Returns:

getScrollTop

@WillMeasure
public int getScrollTop()

Returns:

setScrollTop

@WillMutate
public W setScrollTop(int scrollTop)

Returns:

isInEventThread

public static boolean isInEventThread()

Returns:

the inEventThread