java.lang.Object
- ch.nolix.element.base.Element<CE>
- - ch.nolix.element.configuration.ConfigurableElement<W>
  - - ch.nolix.element.gui.Widget<W,WL>

Type Parameters:

W - The type of a Widget.

WL - The type of the WidgetLook of a Widget.

All Implemented Interfaces:

Castable, IFluentObject<W>, ISmartObject<W>, Listable<W>, Transformable<W>, TypeRequestable, OptionalIdentifiableByString<W>, OptionalTokenable<W>, OptionalIdentifiedByString, OptionalTokened, Rectangular, TopLeftPositioned, TopLeftPositionedRecangular, ContainsElementByStringIdRequestable, EnablingRequestable, ExpansionRequestable, Recalculable, Resettable, IInputActionManager<W>, IConfigurableElement<W>, IElement, IMutableElement<W>, IInputTaker, ISmartElement<W>

Direct Known Subclasses:

Area, BorderWidget, Line
```
public abstract class Widget<W extends Widget<W,WL>,WL extends WidgetLook<WL>>
extends ConfigurableElement<W>
implements EnablingRequestable, ExpansionRequestable, IInputActionManager<W>, IInputTaker, Recalculable, TopLeftPositionedRecangular
```
A Widget is an element on a WidgetGUI. A Widget determines its width and height. A Widget is a ConfigurableElement.

Author:

Silvan Wyss

Field Summary

Fields
Modifier and Type Field Description

static CursorIcon DEFAULT_CURSOR_ICON

Constructor Summary

Constructors
Constructor Description

Widget()
Creates a new Widget.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addOrChangeAttribute(BaseNode attribute)`	Adds or changes the given attribute to the current `Widget`.
`W`	`applyOnBaseLook(IElementTaker<WL> baseLookMutator)`	Applies the given base look mutator to the base look of the current `Widget`.
`W`	`applyOnFocusLook(IElementTaker<WL> focusLookMutator)`	Applies the given focus look mutator to the focus look of the current `Widget`.
`W`	`applyOnHoverLook(IElementTaker<WL> hoverLookMutator)`	Applies the given hover look mutator to the hover look of the current `Widget`.
`boolean`	`belongsDirectltyToGUI()`
`boolean`	`belongsToGUI()`
`boolean`	`belongsToParent()`
`boolean`	`belongsToWidget()`
`boolean`	`containsPointOnGUI(int xPositionOnGUI, int yPositionOnGUI)`
`boolean`	`containsPointOnParent(int xPositionOnParent, int yPositionOnParent)`
`boolean`	`freeViewAreaIsUnderCursor()`	The free view area of a `Widget` is the part of the view area of the `Widget` where does not lie a child `Widget`, that is for painting, of the `Widget`.
`IFrontEndReader`	`fromFrontEnd()`
`LinkedList<Node>`	`getAttributes()`
`LinkedList<Widget<?,?>>`	`getChildWidgets()`
`LinkedList<Widget<?,?>>`	`getChildWidgetsRecursively()`
`CursorIcon`	`getCursorIcon()`
`int`	`getCursorXPosition()`
`int`	`getCursorYPosition()`
`CursorIcon`	`getCustomCursorIcon()`
`int`	`getHeight()`
`int`	`getIndexOnGUI()`
`WidgetParent`	`getParent()`
`WidgetGUI<?>`	`getParentGUI()`
`Widget<?,?>`	`getParentWidget()`
`WL`	`getRefBaseLook()`
`WL`	`getRefFocusLook()`
`WL`	`getRefHoverLook()`
`IKeyBoard`	`getRefKeyBoard()`
`WL`	`getRefLook()`	The current look of a `Widget` depends on its state.
`LinkedList<Widget<?,?>>`	`getRefPaintableWidgets()`
`LinkedList<Widget<?,?>>`	`getRefPaintableWidgetsRecursively()`
`IContainer<IConfigurableElement<?>>`	`getSubConfigurables()`
`int`	`getWidth()`
`int`	`getXPosition()`
`int`	`getXPositionOnGUI()`
`int`	`getYPosition()`
`int`	`getYPositionOnGUI()`
`boolean`	`greysOutWhenDisabled()`
`boolean`	`hasLeftMouseButtonClickAction()`
`boolean`	`hasLeftMouseButtonPressAction()`
`boolean`	`hasLeftMouseButtonReleaseAction()`
`boolean`	`hasMouseMoveAction()`
`boolean`	`hasMouseWheelClickAction()`
`boolean`	`hasMouseWheelPressAction()`
`boolean`	`hasMouseWheelReleaseAction()`
`boolean`	`hasRightMouseButtonClickAction()`
`boolean`	`hasRightMouseButtonPressAction()`
`boolean`	`hasRightMouseButtonReleaseAction()`
`boolean`	`isEnabled()`
`boolean`	`isExpanded()`
`boolean`	`isFocused()`
`boolean`	`isHovered()`
`boolean`	`isUnderCursor()`
`void`	`noteKeyPress(Key key)`	Lets the current `IInputTaker` note a key press.
`void`	`noteKeyRelease(Key key)`	Lets the current `IInputTaker` note a key release.
`void`	`noteKeyTyping(Key key)`	Lets the current `IInputTaker` note a key typing.
`void`	`noteLeftMouseButtonClick()`	Lets the current `IInputTaker` note a left mouse button click.
`void`	`noteLeftMouseButtonPress()`	Lets the current `IInputTaker` note a left mouse button press.
`void`	`noteLeftMouseButtonRelease()`	Lets the current `IInputTaker` note a left mouse button release.
`void`	`noteMouseMove(int cursorXPosition, int cursorYPosition)`	Lets the current `IInputTaker` note a mouse move.
`void`	`noteMouseWheelClick()`	Lets the current `IInputTaker` note a mouse wheel clcik.
`void`	`noteMouseWheelPress()`	Lets the current `IInputTaker` note a mouse wheel press.
`void`	`noteMouseWheelRelease()`	Lets the current `IInputTaker` note a mouse wheel release.
`void`	`noteMouseWheelRotationStep(RotationDirection rotationDirection)`	Lets the current `IInputTaker` note a mouse wheel rotation step.
`void`	`noteRightMouseButtonClick()`	Lets the current `IInputTaker` note a right mouse button click.
`void`	`noteRightMouseButtonPress()`	Lets the current `IInputTaker` note a right mouse button press.
`void`	`noteRightMouseButtonRelease()`	Lets the current `IInputTaker` note a right mouse button release.
`IFrontEndWriter`	`onFrontEnd()`
`void`	`paintRecursively(IPainter painter)`	Paints the current `Widget` recursively using the position on its parent and the given painter.
`void`	`recalculate()`
`W`	`removeGreyOutWhenDisabled()`	Avoids that the current `Widget` grays out when it is disabled.
`W`	`removeLeftMouseButtonClickAction()`	Removes the left mouse button click action of the current `Widget`.
`W`	`removeLeftMouseButtonPressAction()`	Removes the left mouse button press action of the current `Widget`.
`W`	`removeLeftMouseButtonReleaseAction()`	Removes the left mouse button release action of the current `Widget`.
`W`	`removeRightMouseButtonClickAction()`	Removes the right mouse button click action of the current `Widget`.
`W`	`removeRightMouseButtonPressAction()`	Removes the right mouse button press action of the current `Widget`.
`W`	`removeRightMouseButtonReleaseAction()`	Removes the right mouse button release action of the current `Widget`.
`void`	`resetConfigurationOnSelf()`	Resets the configuration of the current `IConfigurableElement` on itself, and on itself only.
`W`	`setCollapsed()`	Sets the current `Widget` collapsed.
`W`	`setContinuousKeyPressAction(I2ElementTaker<W,Key> continuousKeyPressAction)`	Sets the continuous key press action of the current `Widget`.
`W`	`setCustomCursorIcon(CursorIcon customCursorIcon)`	Sets the custom `CursorIcon` of the current `Widget`.
`W`	`setDisabled()`	Sets the current `Widget` disabled.
`W`	`setEnabled()`	Sets the current `Widget` enabled.
`W`	`setExpanded()`	Sets the current `Widget` expanded.
`W`	`setFocused()`	Sets the current `Widget` focused.
`W`	`setGreyOutWhenDisabled()`	Lets the current `Widget` grey out when it is disabled.
`W`	`setHovered()`	Sets the current `Widget` hovered.
`W`	`setLeftMouseButtonClickAction(IElementTaker<W> leftMouseButtonClickAction)`	Sets the left mouse button click action of the current `Widget`.
`W`	`setLeftMouseButtonPressAction(IElementTaker<W> leftMouseButtonPressAction)`	Sets the left mouse button press action of the current `Widget`.
`W`	`setLeftMouseButtonReleaseAction(IElementTaker<W> leftMouseButtonReleaseAction)`	Sets the left mouse button release action of the current `Widget`.
`W`	`setMouseMoveAction(IElementTaker<W> mouseMoveAction)`	Sets the mouse move action of the current `Widget`.
`W`	`setMouseWheelClickAction(IElementTaker<W> mouseWheelClickAction)`	Sets the mouse wheel click action of the current `Widget`.
`W`	`setMouseWheelPressAction(IElementTaker<W> mouseWheelPressAction)`	Sets the mouse wheel press action of the current `Widget`.
`W`	`setMouseWheelReleaseAction(IElementTaker<W> mouseWheelReleaseAction)`	Sets the mouse wheel release action of the current `Widget`.
`void`	`setParent(WidgetGUI<?> parentGUI)`	Sets the `WidgetGUI` the current `Widget` will belong.
`void`	`setPositionOnParent(int xPositionOnParent, int yPositionOnParent)`	Sets the position of the current `Widget` on its parent.
`W`	`setRightMouseButtonClickAction(IElementTaker<W> rightMouseButtonClickAction)`	Sets the right mouse button click action of the current `Widget`.
`W`	`setRightMouseButtonPressAction(IElementTaker<W> rightMouseButtonPressAction)`	Sets the right mouse button press action of the current `Widget`.
`W`	`setRightMouseButtonReleaseAction(IElementTaker<W> rightMouseButtonReleaseAction)`	Sets the right mouse button release action of the current `Widget`.
`W`	`setUnfocused()`	Sets the current `Widget` unfocused.
`W`	`setUnhovered()`	Sets the current `Widget` unhovered.
`abstract boolean`	`showAreaIsUnderCursor()`

Methods inherited from class ch.nolix.element.configuration.ConfigurableElement
getId, getToken, hasId, hasToken, removeId, removeToken, reset, setId, setToken

Methods inherited from class ch.nolix.element.base.Element
equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.nolix.common.generalskillapi.Castable
as

Methods inherited from interface ch.nolix.common.requestapi.EnablingRequestable
isDisabled

Methods inherited from interface ch.nolix.common.requestapi.ExpansionRequestable
isCollapsed

Methods inherited from interface ch.nolix.element.elementapi.IConfigurableElement
containsElement, getSubConfigurablesRecursively, hasRole, resetConfiguration

Methods inherited from interface ch.nolix.element.elementapi.IElement
fillUpAttributesInto, getSpecification, getSpecificationAs, getSpecificationWithoutHeader, saveAsTo, saveAsTo, saveTo, saveTo, toFormatedString, toXML, toXMLAs

Methods inherited from interface ch.nolix.common.generalskillapi.IFluentObject
asConcrete

Methods inherited from interface ch.nolix.element.baseguiapi.IInputActionManager
setContinuousKeyPressAction, setLeftMouseButtonClickAction, setLeftMouseButtonPressAction, setLeftMouseButtonReleaseAction, setMouseMoveAction, setMouseWheelClickAction, setMouseWheelPressAction, setMouseWheelReleaseAction, setRightMouseButtonClickAction, setRightMouseButtonPressAction, setRightMouseButtonReleaseAction

Methods inherited from interface ch.nolix.element.input.IInputTaker
noteInput, noteKeyInput, noteLeftMouseButtonClick, noteLeftMouseButtonPress, noteLeftMouseButtonRelease, noteMouseInput, noteMouseWheelClick, noteMouseWheelPress, noteMouseWheelRelease, noteRightMouseButtonClick, noteRightMouseButtonPress, noteRightMouseButtonRelease

Methods inherited from interface ch.nolix.element.elementapi.IMutableElement
addOrChangeAttribute, addOrChangeAttribute, addOrChangeAttribute, addOrChangeAttributes, resetFrom, resetFrom, resetFrom, resetFromFile

Methods inherited from interface ch.nolix.common.generalskillapi.Listable
intoList, intoListAs

Methods inherited from interface ch.nolix.common.optionalattributeapi.OptionalIdentifiedByString
getIdInQuotes, hasId

Methods inherited from interface ch.nolix.common.optionalattributeapi.OptionalTokened
hasSameTokenAs, hasToken

Methods inherited from interface ch.nolix.common.rasterapi.Rectangular
getDiagonal, getPerimeter, isQuadratic

Methods inherited from interface ch.nolix.common.rasterapi.TopLeftPositionedRecangular
containsPoint, containsPointRelatively

Methods inherited from interface ch.nolix.common.generalskillapi.Transformable
to, to

Methods inherited from interface ch.nolix.common.generalskillapi.TypeRequestable
getType, getTypeInPlural, getTypes, isOfConcreteType, isOfConcreteType, isOfType, isOfType

- Field Detail
  - DEFAULT_CURSOR_ICON
```
public static final CursorIcon DEFAULT_CURSOR_ICON
```
- Constructor Detail
  - Widget
```
public Widget()
```
    Creates a new Widget.
- Method Detail
  - addOrChangeAttribute
```
public void addOrChangeAttribute(BaseNode attribute)
```
    Adds or changes the given attribute to the current Widget.
    
    Specified by:
    
    addOrChangeAttribute in interface IMutableElement<W extends Widget<W,WL>>
    
    Overrides:
    
    addOrChangeAttribute in class ConfigurableElement<W extends Widget<W,WL>>
    
    Parameters:
    
    attribute -
    
    Throws:
    
    InvalidArgumentException - if the given attribute is not valid.
  - applyOnBaseLook
```
public final W applyOnBaseLook(IElementTaker<WL> baseLookMutator)
```
    Applies the given base look mutator to the base look of the current Widget.
    
    Parameters:
    
    baseLookMutator -
    
    Returns:
    
    the current Widget.
  - applyOnFocusLook
```
public final W applyOnFocusLook(IElementTaker<WL> focusLookMutator)
```
    Applies the given focus look mutator to the focus look of the current Widget.
    
    Parameters:
    
    focusLookMutator -
    
    Returns:
    
    the current Widget.
  - applyOnHoverLook
```
public final W applyOnHoverLook(IElementTaker<WL> hoverLookMutator)
```
    Applies the given hover look mutator to the hover look of the current Widget.
    
    Parameters:
    
    hoverLookMutator -
    
    Returns:
    
    the current Widget.
  - belongsDirectltyToGUI
```
public final boolean belongsDirectltyToGUI()
```
    Returns:
    
    true if the current Widget belongs directly to a WidgetGUI.
  - belongsToGUI
```
public final boolean belongsToGUI()
```
    Returns:
    
    true if the current Widget belongs to a WidgetGUI, directly or indirectly.
  - belongsToParent
```
public final boolean belongsToParent()
```
    Returns:
    
    true if the current Widget belongs directly to a WidgetGUI or another Widget.
  - belongsToWidget
```
public final boolean belongsToWidget()
```
    Returns:
    
    true if the current Widget belongs directly to another Widget.
  - containsPointOnGUI
```
public final boolean containsPointOnGUI(int xPositionOnGUI,
                                        int yPositionOnGUI)
```
    Parameters:
    
    xPositionOnGUI -
    
    yPositionOnGUI -
    
    Returns:
    
    true if the current Widget contains the point, that has: -the given x-position on the WidgetGUI the current Widget belongs to -the given y-position on the WidgetGUI the current Widget belongs to
  - containsPointOnParent
```
public final boolean containsPointOnParent(int xPositionOnParent,
                                           int yPositionOnParent)
```
    Parameters:
    
    xPositionOnParent -
    
    yPositionOnParent -
    
    Returns:
    
    true if the current Widget contains the point, that has: -the given x-position on the parent the current Widget belongs to -the given y-position on the parent the current Widget belongs to
  - freeViewAreaIsUnderCursor
```
public final boolean freeViewAreaIsUnderCursor()
```
    The free view area of a Widget is the part of the view area of the Widget where does not lie a child Widget, that is for painting, of the Widget.
    
    Returns:
    
    true if the free view area of the curent Widget is under the cursor.
  - fromFrontEnd
```
public IFrontEndReader fromFrontEnd()
```
    Returns:
    
    the IFrontEndReader of the parent GUI of the current Widget.
    
    Throws:
    
    ArgumentDoesNotBelongToParentException - if the current Widget does not belong to a GUI.
  - getAttributes
```
public LinkedList<Node> getAttributes()
```
    Specified by:
    
    getAttributes in interface IElement
    
    Overrides:
    
    getAttributes in class ConfigurableElement<W extends Widget<W,WL>>
    
    Returns:
    
    the attributes of the current IElement.
  - getChildWidgets
```
public final LinkedList<Widget<?,?>> getChildWidgets()
```
    Returns:
    
    the child Widgets of the current Widget.
  - getChildWidgetsRecursively
```
public final LinkedList<Widget<?,?>> getChildWidgetsRecursively()
```
    Returns:
    
    the child Widgets of the current Widget recursively.
  - getCursorIcon
```
public CursorIcon getCursorIcon()
```
    Returns:
    
    the CursorIcon of the current Widget.
  - getCursorXPosition
```
public final int getCursorXPosition()
```
    Returns:
    
    the x-position of the cursor on the current Widget.
  - getCursorYPosition
```
public final int getCursorYPosition()
```
    Returns:
    
    the y-position of the cursor on the current Widget.
  - getCustomCursorIcon
```
public final CursorIcon getCustomCursorIcon()
```
    Returns:
    
    the custom CursorIcon of the current Widget.
  - getHeight
```
public final int getHeight()
```
    Specified by:
    
    getHeight in interface Rectangular
    
    Returns:
    
    the height of the current Rectangular.
  - getIndexOnGUI
```
public final int getIndexOnGUI()
```
    Returns:
    
    the index of the current Widget on the WidgetGUI the current Widget belongs to.
    
    Throws:
    
    InvalidArgumentException - if the current Widget does not belong to a WidgetGUI.
  - getParent
```
public final WidgetParent getParent()
```
    Returns:
    
    the parent the current Widget belongs to.
    
    Throws:
    
    ArgumentDoesNotBelongToParentException - if the current Widget does not belong to a parent.
  - getParentGUI
```
public final WidgetGUI<?> getParentGUI()
```
    Returns:
    
    the GUI the current Widget belongs to, directly or indirectly.
    
    Throws:
    
    ArgumentDoesNotBelongToParentException - if the current Widget does not belong to a GUI.
  - getParentWidget
```
public final Widget<?,?> getParentWidget()
```
    Returns:
    
    the Widget the current Widget belongs to.
    
    Throws:
    
    ArgumentDoesNotBelongToParentException - if the current Widget does not belong to a Widget.
  - getRefBaseLook
```
public final WL getRefBaseLook()
```
    Returns:
    
    the base look of the current Widget.
  - getRefFocusLook
```
public final WL getRefFocusLook()
```
    Returns:
    
    the focus look of the current Widget.
  - getRefHoverLook
```
public final WL getRefHoverLook()
```
    Returns:
    
    the hover look of the current Widget.
  - getRefKeyBoard
```
public final IKeyBoard getRefKeyBoard()
```
    Returns:
    
    the IKeyBoard of the GUI the current Widget belongs to.
    
    Throws:
    
    ArgumentDoesNotBelongToParentException - if the current Widget does not belong to a GUI.
  - getRefLook
```
public final WL getRefLook()
```
    The current look of a Widget depends on its state. -not hovered, not focused -> base look -hovered, not focused -> hover look -hovered, focused -> hover look -focused, not hovered -> focus look
    
    Returns:
    
    the current look of the current Widget.
  - getRefPaintableWidgets
```
public final LinkedList<Widget<?,?>> getRefPaintableWidgets()
```
    Returns:
    
    the paintable Widgets of the current Widget.
  - getRefPaintableWidgetsRecursively
```
public final LinkedList<Widget<?,?>> getRefPaintableWidgetsRecursively()
```
    Returns:
    
    the paintable Widgets of the current Widget recursively.
  - getSubConfigurables
```
public final IContainer<IConfigurableElement<?>> getSubConfigurables()
```
    Specified by:
    
    getSubConfigurables in interface IConfigurableElement<W extends Widget<W,WL>>
    
    Returns:
    
    the IConfigurableElements of the current IConfigurableElement.
  - getWidth
```
public final int getWidth()
```
    Specified by:
    
    getWidth in interface Rectangular
    
    Returns:
    
    the width of the current Rectangular.
  - getXPosition
```
public final int getXPosition()
```
    Specified by:
    
    getXPosition in interface TopLeftPositioned
    
    Returns:
    
    the top left x-position of the current TopLeftPositioned.
  - getXPositionOnGUI
```
public final int getXPositionOnGUI()
```
    Returns:
    
    the x-position of the current Widget on the parent of the current Widget.
  - getYPosition
```
public final int getYPosition()
```
    Specified by:
    
    getYPosition in interface TopLeftPositioned
    
    Returns:
    
    the top left y-position of the current TopLeftPositioned.
  - getYPositionOnGUI
```
public final int getYPositionOnGUI()
```
    Returns:
    
    the y-position of the current Widget on the parent of the current Widget.
  - greysOutWhenDisabled
```
public final boolean greysOutWhenDisabled()
```
    Returns:
    
    true if the current Widget grays out when it is disabled.
  - hasLeftMouseButtonClickAction
```
public final boolean hasLeftMouseButtonClickAction()
```
    Returns:
    
    true if the current Widget has a left mouse button click action.
  - hasLeftMouseButtonPressAction
```
public final boolean hasLeftMouseButtonPressAction()
```
    Returns:
    
    true if the current Widget has a left mouse button press action.
  - hasLeftMouseButtonReleaseAction
```
public final boolean hasLeftMouseButtonReleaseAction()
```
    Returns:
    
    true if the current Widget has a left mouse button release action.
  - hasMouseMoveAction
```
public final boolean hasMouseMoveAction()
```
    Returns:
    
    true if the current Widget has a mouse move action.
  - hasMouseWheelClickAction
```
public final boolean hasMouseWheelClickAction()
```
    Returns:
    
    true if the current Widget has a mouse wheel click action.
  - hasMouseWheelPressAction
```
public final boolean hasMouseWheelPressAction()
```
    Returns:
    
    true if the current Widget has a mouse wheel press action.
  - hasMouseWheelReleaseAction
```
public final boolean hasMouseWheelReleaseAction()
```
    Returns:
    
    true if the current Widget has a mouse wheel release action.
  - hasRightMouseButtonClickAction
```
public final boolean hasRightMouseButtonClickAction()
```
    Returns:
    
    true if the current Widget has a right mouse button click action.
  - hasRightMouseButtonPressAction
```
public final boolean hasRightMouseButtonPressAction()
```
    Returns:
    
    true if the current Widget has a right mouse button press action.
  - hasRightMouseButtonReleaseAction
```
public final boolean hasRightMouseButtonReleaseAction()
```
    Returns:
    
    true if the current Widget has a right mouse button release action.
  - isEnabled
```
public final boolean isEnabled()
```
    Specified by:
    
    isEnabled in interface EnablingRequestable
    
    Returns:
    
    true if the current EnablingRequestable is enabled.
  - isExpanded
```
public final boolean isExpanded()
```
    Specified by:
    
    isExpanded in interface ExpansionRequestable
    
    Returns:
    
    true if the current ExpansionRequestable is expanded.
  - isFocused
```
public final boolean isFocused()
```
    Returns:
    
    true if the current Widget is focused.
  - isHovered
```
public final boolean isHovered()
```
    Returns:
    
    true if the current Widget is hovered.
  - isUnderCursor
```
public final boolean isUnderCursor()
```
    Returns:
    
    true if the current Widget is under the cursor.
  - noteKeyPress
```
public final void noteKeyPress(Key key)
```
    Lets the current IInputTaker note a key press.
    
    Specified by:
    
    noteKeyPress in interface IInputTaker
  - noteKeyRelease
```
public final void noteKeyRelease(Key key)
```
    Lets the current IInputTaker note a key release.
    
    Specified by:
    
    noteKeyRelease in interface IInputTaker
  - noteKeyTyping
```
public final void noteKeyTyping(Key key)
```
    Lets the current IInputTaker note a key typing.
    
    Specified by:
    
    noteKeyTyping in interface IInputTaker
  - noteLeftMouseButtonClick
```
public final void noteLeftMouseButtonClick()
```
    Lets the current IInputTaker note a left mouse button click.
    
    Specified by:
    
    noteLeftMouseButtonClick in interface IInputTaker
  - noteLeftMouseButtonPress
```
public final void noteLeftMouseButtonPress()
```
    Lets the current IInputTaker note a left mouse button press.
    
    Specified by:
    
    noteLeftMouseButtonPress in interface IInputTaker
  - noteLeftMouseButtonRelease
```
public final void noteLeftMouseButtonRelease()
```
    Lets the current IInputTaker note a left mouse button release.
    
    Specified by:
    
    noteLeftMouseButtonRelease in interface IInputTaker
  - noteMouseMove
```
public final void noteMouseMove(int cursorXPosition,
                                int cursorYPosition)
```
    Lets the current IInputTaker note a mouse move. The given cursorXPositionOnViewArea and cursorYPositionOnViewArea are the new position of the cursor.
    
    Specified by:
    
    noteMouseMove in interface IInputTaker
  - noteMouseWheelClick
```
public final void noteMouseWheelClick()
```
    Lets the current IInputTaker note a mouse wheel clcik.
    
    Specified by:
    
    noteMouseWheelClick in interface IInputTaker
  - noteMouseWheelPress
```
public final void noteMouseWheelPress()
```
    Lets the current IInputTaker note a mouse wheel press.
    
    Specified by:
    
    noteMouseWheelPress in interface IInputTaker
  - noteMouseWheelRelease
```
public final void noteMouseWheelRelease()
```
    Lets the current IInputTaker note a mouse wheel release.
    
    Specified by:
    
    noteMouseWheelRelease in interface IInputTaker
  - noteMouseWheelRotationStep
```
public void noteMouseWheelRotationStep(RotationDirection rotationDirection)
```
    Lets the current IInputTaker note a mouse wheel rotation step.
    
    Specified by:
    
    noteMouseWheelRotationStep in interface IInputTaker
  - noteRightMouseButtonClick
```
public final void noteRightMouseButtonClick()
```
    Lets the current IInputTaker note a right mouse button click.
    
    Specified by:
    
    noteRightMouseButtonClick in interface IInputTaker
  - noteRightMouseButtonPress
```
public final void noteRightMouseButtonPress()
```
    Lets the current IInputTaker note a right mouse button press.
    
    Specified by:
    
    noteRightMouseButtonPress in interface IInputTaker
  - noteRightMouseButtonRelease
```
public final void noteRightMouseButtonRelease()
```
    Lets the current IInputTaker note a right mouse button release.
    
    Specified by:
    
    noteRightMouseButtonRelease in interface IInputTaker
  - onFrontEnd
```
public IFrontEndWriter onFrontEnd()
```
    Returns:
    
    the IFrontEndWriter of the parent GUI of the current Widget.
    
    Throws:
    
    ArgumentDoesNotBelongToParentException - if the current Widget does not belong to a GUI.
  - paintRecursively
```
public final void paintRecursively(IPainter painter)
```
    Paints the current Widget recursively using the position on its parent and the given painter. This method ensures that the given painter has the same position at the end of the painting as the beginning.
    
    Parameters:
    
    painter -
  - recalculate
```
public final void recalculate()
```
    Specified by:
    
    recalculate in interface Recalculable
  - removeGreyOutWhenDisabled
```
public final W removeGreyOutWhenDisabled()
```
    Avoids that the current Widget grays out when it is disabled.
    
    Returns:
    
    the current Widget.
  - removeLeftMouseButtonClickAction
```
public final W removeLeftMouseButtonClickAction()
```
    Removes the left mouse button click action of the current Widget.
    
    Returns:
    
    the current Widget.
  - removeLeftMouseButtonPressAction
```
public final W removeLeftMouseButtonPressAction()
```
    Removes the left mouse button press action of the current Widget.
    
    Returns:
    
    the current Widget.
  - removeLeftMouseButtonReleaseAction
```
public final W removeLeftMouseButtonReleaseAction()
```
    Removes the left mouse button release action of the current Widget.
    
    Returns:
    
    the current Widget.
  - removeRightMouseButtonClickAction
```
public final W removeRightMouseButtonClickAction()
```
    Removes the right mouse button click action of the current Widget.
    
    Returns:
    
    the current Widget.
  - removeRightMouseButtonPressAction
```
public final W removeRightMouseButtonPressAction()
```
    Removes the right mouse button press action of the current Widget.
    
    Returns:
    
    the current Widget.
  - removeRightMouseButtonReleaseAction
```
public final W removeRightMouseButtonReleaseAction()
```
    Removes the right mouse button release action of the current Widget.
    
    Returns:
    
    the current Widget.
  - resetConfigurationOnSelf
```
public final void resetConfigurationOnSelf()
```
    Resets the configuration of the current IConfigurableElement on itself, and on itself only.
    
    Specified by:
    
    resetConfigurationOnSelf in interface IConfigurableElement<W extends Widget<W,WL>>
  - setCollapsed
```
public final W setCollapsed()
```
    Sets the current Widget collapsed.
    
    Returns:
    
    the current Widget.
  - setContinuousKeyPressAction
```
public final W setContinuousKeyPressAction(I2ElementTaker<W,Key> continuousKeyPressAction)
```
    Sets the continuous key press action of the current Widget.
    
    Specified by:
    
    setContinuousKeyPressAction in interface IInputActionManager<W extends Widget<W,WL>>
    
    Returns:
    
    the current Widget.
    
    Throws:
    
    ArgumentIsNullException - if the given continuousKeyPressAction is null.
  - setCustomCursorIcon
```
public final W setCustomCursorIcon(CursorIcon customCursorIcon)
```
    Sets the custom CursorIcon of the current Widget.
    
    Parameters:
    
    customCursorIcon -
    
    Returns:
    
    the current Widget.
    
    Throws:
    
    ArgumentIsNullException - if the given customCursorIcon is null.
  - setDisabled
```
public final W setDisabled()
```
    Sets the current Widget disabled.
    
    Returns:
    
    the current Widget.
  - setEnabled
```
public final W setEnabled()
```
    Sets the current Widget enabled.
    
    Returns:
    
    the current Widget.
  - setExpanded
```
public final W setExpanded()
```
    Sets the current Widget expanded.
    
    Returns:
    
    the current Widget.
  - setFocused
```
public final W setFocused()
```
    Sets the current Widget focused.
    
    Returns:
    
    the current Widget.
  - setGreyOutWhenDisabled
```
public final W setGreyOutWhenDisabled()
```
    Lets the current Widget grey out when it is disabled.
    
    Returns:
    
    the current Widget.
  - setHovered
```
public final W setHovered()
```
    Sets the current Widget hovered.
    
    Returns:
    
    the current Widget.
  - setLeftMouseButtonClickAction
```
public final W setLeftMouseButtonClickAction(IElementTaker<W> leftMouseButtonClickAction)
```
    Sets the left mouse button click action of the current Widget.
    
    Specified by:
    
    setLeftMouseButtonClickAction in interface IInputActionManager<W extends Widget<W,WL>>
    
    Parameters:
    
    leftMouseButtonClickAction -
    
    Returns:
    
    the current Widget.
    
    Throws:
    
    ArgumentIsNullException - if the given leftMouseButtonClickAction is null.
  - setLeftMouseButtonPressAction
```
public final W setLeftMouseButtonPressAction(IElementTaker<W> leftMouseButtonPressAction)
```
    Sets the left mouse button press action of the current Widget.
    
    Specified by:
    
    setLeftMouseButtonPressAction in interface IInputActionManager<W extends Widget<W,WL>>
    
    Parameters:
    
    leftMouseButtonPressAction -
    
    Returns:
    
    the current Widget.
    
    Throws:
    
    ArgumentIsNullException - if the given leftMouseButtonPressAction is null.
  - setLeftMouseButtonReleaseAction
```
public final W setLeftMouseButtonReleaseAction(IElementTaker<W> leftMouseButtonReleaseAction)
```
    Sets the left mouse button release action of the current Widget.
    
    Specified by:
    
    setLeftMouseButtonReleaseAction in interface IInputActionManager<W extends Widget<W,WL>>
    
    Parameters:
    
    leftMouseButtonReleaseAction -
    
    Returns:
    
    the current Widget.
    
    Throws:
    
    ArgumentIsNullException - if the given leftMouseButtonReleaseAction is null.
  - setMouseMoveAction
```
public final W setMouseMoveAction(IElementTaker<W> mouseMoveAction)
```
    Sets the mouse move action of the current Widget.
    
    Specified by:
    
    setMouseMoveAction in interface IInputActionManager<W extends Widget<W,WL>>
    
    Parameters:
    
    mouseMoveAction -
    
    Returns:
    
    the current Widget.
    
    Throws:
    
    ArgumentIsNullException - if the given leftMouseButtonPressAction is null.
  - setMouseWheelClickAction
```
public final W setMouseWheelClickAction(IElementTaker<W> mouseWheelClickAction)
```
    Sets the mouse wheel click action of the current Widget.
    
    Specified by:
    
    setMouseWheelClickAction in interface IInputActionManager<W extends Widget<W,WL>>
    
    Parameters:
    
    mouseWheelClickAction -
    
    Returns:
    
    the current Widget.
    
    Throws:
    
    ArgumentIsNullException - if the given mouseWheelClickAction is null.
  - setMouseWheelPressAction
```
public final W setMouseWheelPressAction(IElementTaker<W> mouseWheelPressAction)
```
    Sets the mouse wheel press action of the current Widget.
    
    Specified by:
    
    setMouseWheelPressAction in interface IInputActionManager<W extends Widget<W,WL>>
    
    Parameters:
    
    mouseWheelPressAction -
    
    Returns:
    
    the current Widget.
    
    Throws:
    
    ArgumentIsNullException - if the given mouseWheelPressAction is null.
  - setMouseWheelReleaseAction
```
public final W setMouseWheelReleaseAction(IElementTaker<W> mouseWheelReleaseAction)
```
    Sets the mouse wheel release action of the current Widget.
    
    Specified by:
    
    setMouseWheelReleaseAction in interface IInputActionManager<W extends Widget<W,WL>>
    
    Parameters:
    
    mouseWheelReleaseAction -
    
    Returns:
    
    the current Widget.
    
    Throws:
    
    ArgumentIsNullException - if the given mouseWheelReleaseAction is null.
  - setParent
```
public final void setParent(WidgetGUI<?> parentGUI)
```
    Sets the WidgetGUI the current Widget will belong.
    
    Parameters:
    
    parentGUI -
    
    Throws:
    
    ArgumentIsNullException - if the given parentGUI is null.
    
    InvalidArgumentException - if the current Widget belongs already to a parent.
  - setPositionOnParent
```
public final void setPositionOnParent(int xPositionOnParent,
                                      int yPositionOnParent)
```
    Sets the position of the current Widget on its parent.
    
    Parameters:
    
    xPositionOnParent -
    
    yPositionOnParent -
  - setRightMouseButtonClickAction
```
public final W setRightMouseButtonClickAction(IElementTaker<W> rightMouseButtonClickAction)
```
    Sets the right mouse button click action of the current Widget.
    
    Specified by:
    
    setRightMouseButtonClickAction in interface IInputActionManager<W extends Widget<W,WL>>
    
    Parameters:
    
    rightMouseButtonClickAction -
    
    Returns:
    
    the current Widget.
    
    Throws:
    
    ArgumentIsNullException - if the given rightMouseButtonClickAction is null.
  - setRightMouseButtonPressAction
```
public final W setRightMouseButtonPressAction(IElementTaker<W> rightMouseButtonPressAction)
```
    Sets the right mouse button press action of the current Widget.
    
    Specified by:
    
    setRightMouseButtonPressAction in interface IInputActionManager<W extends Widget<W,WL>>
    
    Parameters:
    
    rightMouseButtonPressAction -
    
    Returns:
    
    the current Widget.
    
    Throws:
    
    ArgumentIsNullException - if the given rightMouseButtonPressAction is null.
  - setRightMouseButtonReleaseAction
```
public final W setRightMouseButtonReleaseAction(IElementTaker<W> rightMouseButtonReleaseAction)
```
    Sets the right mouse button release action of the current Widget.
    
    Specified by:
    
    setRightMouseButtonReleaseAction in interface IInputActionManager<W extends Widget<W,WL>>
    
    Parameters:
    
    rightMouseButtonReleaseAction -
    
    Returns:
    
    the current Widget.
    
    Throws:
    
    ArgumentIsNullException - if the given rightMouseButtonReleaseAction is null.
  - setUnhovered
```
public final W setUnhovered()
```
    Sets the current Widget unhovered.
    
    Returns:
    
    the current Widget.
  - setUnfocused
```
public final W setUnfocused()
```
    Sets the current Widget unfocused.
    
    Returns:
    
    the current Widget.
  - showAreaIsUnderCursor
```
public abstract boolean showAreaIsUnderCursor()
```
    Returns:
    
    true if the view are of the current Widget is under the cursor.

Class Widget<W extends Widget<W,​WL>,​WL extends WidgetLook<WL>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class ch.nolix.element.configuration.ConfigurableElement

Methods inherited from class ch.nolix.element.base.Element

Methods inherited from class java.lang.Object

Methods inherited from interface ch.nolix.common.generalskillapi.Castable

Methods inherited from interface ch.nolix.common.requestapi.EnablingRequestable

Methods inherited from interface ch.nolix.common.requestapi.ExpansionRequestable

Methods inherited from interface ch.nolix.element.elementapi.IConfigurableElement

Methods inherited from interface ch.nolix.element.elementapi.IElement

Methods inherited from interface ch.nolix.common.generalskillapi.IFluentObject

Methods inherited from interface ch.nolix.element.baseguiapi.IInputActionManager

Methods inherited from interface ch.nolix.element.input.IInputTaker

Methods inherited from interface ch.nolix.element.elementapi.IMutableElement

Methods inherited from interface ch.nolix.common.generalskillapi.Listable

Methods inherited from interface ch.nolix.common.optionalattributeapi.OptionalIdentifiedByString

Methods inherited from interface ch.nolix.common.optionalattributeapi.OptionalTokened

Methods inherited from interface ch.nolix.common.rasterapi.Rectangular

Methods inherited from interface ch.nolix.common.rasterapi.TopLeftPositionedRecangular

Methods inherited from interface ch.nolix.common.generalskillapi.Transformable

Methods inherited from interface ch.nolix.common.generalskillapi.TypeRequestable

Field Detail

DEFAULT_CURSOR_ICON

Constructor Detail

Widget

Method Detail

addOrChangeAttribute

applyOnBaseLook

applyOnFocusLook

applyOnHoverLook

belongsDirectltyToGUI

belongsToGUI

belongsToParent

belongsToWidget

containsPointOnGUI

containsPointOnParent

freeViewAreaIsUnderCursor

fromFrontEnd

getAttributes

getChildWidgets

getChildWidgetsRecursively

getCursorIcon

getCursorXPosition

getCursorYPosition

getCustomCursorIcon

getHeight

getIndexOnGUI

getParent

getParentGUI

getParentWidget

getRefBaseLook

getRefFocusLook

getRefHoverLook

getRefKeyBoard

getRefLook

getRefPaintableWidgets

getRefPaintableWidgetsRecursively

getSubConfigurables

getWidth

getXPosition

getXPositionOnGUI

getYPosition

getYPositionOnGUI

greysOutWhenDisabled

hasLeftMouseButtonClickAction

hasLeftMouseButtonPressAction

hasLeftMouseButtonReleaseAction

hasMouseMoveAction

hasMouseWheelClickAction

hasMouseWheelPressAction

hasMouseWheelReleaseAction

hasRightMouseButtonClickAction

hasRightMouseButtonPressAction

hasRightMouseButtonReleaseAction

isEnabled

isExpanded

isFocused

isHovered

Class Widget<W extends Widget<W,WL>,WL extends WidgetLook<WL>>