MapWidget (BKCommonLib 1.15.1-v1-SNAPSHOT API)

java.lang.Object
- com.bergerkiller.bukkit.common.map.widgets.MapWidget

All Implemented Interfaces:

Tickable, MapDisplayEvents

Direct Known Subclasses:

MapWidgetAnvil, MapWidgetButton, MapWidgetRoot, MapWidgetTabView, MapWidgetTabView.Tab, MapWidgetText, MapWidgetWindow
```
public class MapWidget
extends Object
implements MapDisplayEvents
```
A single rectangular element on the map

Field Summary

Fields
Modifier and Type	Field and Description
`protected MapDisplay`	`display`
`protected MapDisplay.Layer`	`layer`
`protected MapWidget`	`parent`
`protected MapWidgetRoot`	`root`
`protected MapCanvas`	`view`

Constructor Summary

Constructors
Constructor and Description

MapWidget()

Constructors
Constructor and Description
`MapWidget()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activate()` Activates this widget, but only when the widget is enabled.
`<T extends MapWidget> T`	`addWidget(T widget)` Adds a new child widget to this widget
`MapWidget`	`clear()` Removes all the displayed contents of this widget
`void`	`clearWidgets()` Removes all previously added widgets
`void`	`deactivate()` If this widget or a child thereof is activated, this method de-activates that widget.
`void`	`focus()` Gives this widget the focus.
`int`	`getAbsoluteX()` Gets the x-position of this widget as drawn onto the map display
`int`	`getAbsoluteY()` Gets the y-position of this widget as drawn onto the map display
`MapDisplay`	`getDisplay()` Gets the map display this widget is attached to.
`int`	`getHeight()` Gets the height of this widget
`MapWidget`	`getNextInputWidget()` Gets the child widget to which keyboard/mouse input and events are redirected
`MapWidget`	`getParent()` Gets the parent node of this widget
`MapWidget`	`getWidget(int index)` Gets a widget stored at a particular index in the list of child widgets.
`int`	`getWidgetCount()` Gets the number of child widgets
`List<MapWidget>`	`getWidgets()` Gets an immutable list of children of this widget.
`int`	`getWidth()` Gets the width of this widget
`int`	`getX()` Gets the x-position of this widget relative to the parent
`int`	`getY()` Gets the y-position of this widget relative to the parent
`protected void`	`handleNavigation(MapKeyEvent event)` Handles key navigation of the widgets, changing which widgets are focused and activated.
`void`	`invalidate()` Invalidates the widget, causing it to be redrawn in the future
`boolean`	`isActivated()` Gets whether this widget has been activated.
`boolean`	`isEnabled()` Gets whether this widget is currently enabled using `#setEnabled(enabled)`.
`boolean`	`isFocusable()` Gets whether or not it is possible for this widget to be focused
`boolean`	`isFocused()` Gets whether this widget currently has focus.
`boolean`	`isNavigableFocus()` Gets whether this map widget is a potential widget that can be focused by navigating using W/A/S/D.
`boolean`	`isVisible()` Gets whether this widget is visible
`protected MapWidget`	`navigateNextWidget(List<MapWidget> widgets, MapPlayerInput.Key key)` Selects the next widget to give focus to after receiving player input to navigate around.
`void`	`onActivate()` Called right after the user presses spacebar to 'enter' this widget.
`void`	`onAttached()` Called when the widget is attached to a map display
`void`	`onBlur()` Called right before this item loses the focus
`void`	`onBoundsChanged()` Called when the bounding box area of this widget was changed
`void`	`onDeactivate()` Called right before a new widget becomes activated when this widget was previously activated.
`void`	`onDetached()` Called when a widget is removed from a map display
`void`	`onDraw()` Called when the widget should be re-drawn onto the map display.
`void`	`onFocus()` Called right after this item is focused using W/A/S/D navigation controls
`void`	`onKey(MapKeyEvent event)` Callback function called every tick while a key is pressed down.
`void`	`onKeyPressed(MapKeyEvent event)` Callback function called when a key changed from not-pressed to pressed down These callbacks are called before `MapDisplayEvents.onTick()`.
`void`	`onKeyReleased(MapKeyEvent event)` Callback function called when a key changed from pressed to not pressed down These callbacks are called before `MapDisplayEvents.onTick()`.
`void`	`onLeftClick(MapClickEvent event)` Callback function called when a player left-clicks the map held in an item frame showing this Map Display.
`void`	`onMapItemChanged()` Callback function called when the map item of this Map Display changed
`void`	`onRightClick(MapClickEvent event)` Callback function called when a player right-clicks the map held in an item frame showing this Map Display.
`void`	`onStatusChanged(MapStatusEvent event)` Callback function called when a widget in the map display wishes to broadcast a status change.
`void`	`onTick()` Called every tick to refresh this widget.
`void`	`performTickUpdates()` Performs `onTick()` and `onDraw()` update operations, and other widget refreshing logic needed to run in the background.
`void`	`removeWidget()` Removes this widget from its parent.
`boolean`	`removeWidget(MapWidget widget)` Removes a child widget from this widget.
`void`	`sendStatusChange(MapEventPropagation propagationMode, String name)` Sends a status change to all widgets, the propagation mode defining who receives the status change and in what order.
`void`	`sendStatusChange(MapEventPropagation propagationMode, String name, Object argument)` Sends a status change to all widgets, the propagation mode defining who receives the status change and in what order.
`void`	`sendStatusChange(String name)` Broadcasts a status change to all widgets of the display this widget is attached to
`void`	`sendStatusChange(String name, Object argument)` Broadcasts a status change to all widgets of the display this widget is attached to
`MapWidget`	`setBounds(int x, int y, int width, int height)` Changes the bounds of this widget
`void`	`setDepthOffset(int z)` Changes the depth offset of this widget relative to the parent.
`MapWidget`	`setEnabled(boolean enabled)` Sets whether this widget is currently enabled.
`void`	`setFocusable(boolean focusable)` Sets whether or not it is possible for this widget to be focused
`MapWidget`	`setPosition(int x, int y)` Changes the position of this widget relative to the parent
`MapWidget`	`setRetainChildWidgets(boolean retain)` Sets whether child widgets are retained when this widget is removed from a parent.
`MapWidget`	`setSize(Dimension dimension)` Changes the size of this widget
`MapWidget`	`setSize(int width, int height)` Changes the size of this widget
`MapWidget`	`setVisible(boolean visible)` Sets whether this widget is visible
`<T extends MapWidget> T`	`swapWidget(MapWidget oldWidget, T newWidget)` Replaces a widget with a new widget at the exact same index.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - root
```
protected MapWidgetRoot root
```
  - parent
```
protected MapWidget parent
```
  - display
```
protected MapDisplay display
```
  - layer
```
protected MapDisplay.Layer layer
```
  - view
```
protected MapCanvas view
```
- Constructor Detail
  - MapWidget
```
public MapWidget()
```
- Method Detail
  - onAttached
```
public void onAttached()
```
    Called when the widget is attached to a map display
    
    Specified by:
    
    onAttached in interface MapDisplayEvents
  - onDetached
```
public void onDetached()
```
    Called when a widget is removed from a map display
    
    Specified by:
    
    onDetached in interface MapDisplayEvents
  - onActivate
```
public void onActivate()
```
    Called right after the user presses spacebar to 'enter' this widget. This function is only called when setFocusable(boolean) is set to true. By default this function will activate and enter the element, allowing input to be handled by this widget. By overriding this base functionality can be disabled.
  - onDeactivate
```
public void onDeactivate()
```
    Called right before a new widget becomes activated when this widget was previously activated. This method is always called at most once after onActivate() is called.
  - onFocus
```
public void onFocus()
```
    Called right after this item is focused using W/A/S/D navigation controls
  - onBlur
```
public void onBlur()
```
    Called right before this item loses the focus
  - onTick
```
public void onTick()
```
    Called every tick to refresh this widget. The base #update() automatically calls onDraw() when the widget is invalidated.
    
    Specified by:
    
    onTick in interface Tickable
    
    Specified by:
    
    onTick in interface MapDisplayEvents
  - onDraw
```
public void onDraw()
```
    Called when the widget should be re-drawn onto the map display. When this is called, the old area the widget was displayed has already been cleared.
  - onBoundsChanged
```
public void onBoundsChanged()
```
    Called when the bounding box area of this widget was changed
  - getParent
```
public final MapWidget getParent()
```
    Gets the parent node of this widget
    
    Returns:
    
    parent node, null if this is the root node
  - getNextInputWidget
```
public final MapWidget getNextInputWidget()
```
    Gets the child widget to which keyboard/mouse input and events are redirected
    
    Returns:
    
    next input widget
  - setDepthOffset
```
public final void setDepthOffset(int z)
```
    Changes the depth offset of this widget relative to the parent. By increasing this value it can be ensured that this widget sits on top of another widget. The default depth offset is 0, putting it on equal depth as other children.
    
    Parameters:
    
    z - depth offset
  - getX
```
public final int getX()
```
    Gets the x-position of this widget relative to the parent
    
    Returns:
    
    x-position
  - getY
```
public final int getY()
```
    Gets the y-position of this widget relative to the parent
    
    Returns:
    
    y-position
  - getWidth
```
public final int getWidth()
```
    Gets the width of this widget
    
    Returns:
    
    width
  - getHeight
```
public final int getHeight()
```
    Gets the height of this widget
    
    Returns:
    
    height
  - getAbsoluteX
```
public final int getAbsoluteX()
```
    Gets the x-position of this widget as drawn onto the map display
    
    Returns:
    
    absolute x-position
  - getAbsoluteY
```
public final int getAbsoluteY()
```
    Gets the y-position of this widget as drawn onto the map display
    
    Returns:
    
    absolute y-position
  - getDisplay
```
public final MapDisplay getDisplay()
```
    Gets the map display this widget is attached to. Returns null if not attached yet.
    
    Returns:
    
    map display
  - isVisible
```
public final boolean isVisible()
```
    Gets whether this widget is visible
    
    Returns:
    
    True if visible
  - setVisible
```
public final MapWidget setVisible(boolean visible)
```
    Sets whether this widget is visible
    
    Parameters:
    
    visible -
    
    Returns:
    
    this map widget
  - isFocusable
```
public final boolean isFocusable()
```
    Gets whether or not it is possible for this widget to be focused
    
    Returns:
    
    True if this widget can receive focus
  - setFocusable
```
public final void setFocusable(boolean focusable)
```
    Sets whether or not it is possible for this widget to be focused
    
    Parameters:
    
    focusable - to set to
  - isFocused
```
public final boolean isFocused()
```
    Gets whether this widget currently has focus. The focused widget is the widget which will be activated when the user presses spacebar.
    
    Returns:
    
    True if focused
  - focus
```
public final void focus()
```
    Gives this widget the focus. When the user presses spacebar, this will be the widget that is activated.
  - isActivated
```
public final boolean isActivated()
```
    Gets whether this widget has been activated. All the focusable children of the activated widget can be switched between using W/A/S/D. Only focusable widgets can become activated.
    
    Returns:
    
    True if activated
  - activate
```
public final void activate()
```
    Activates this widget, but only when the widget is enabled. Equivalent to calling onActivate() directly.
  - deactivate
```
public final void deactivate()
```
    If this widget or a child thereof is activated, this method de-activates that widget. It will in turn activate a parent of this widget.
  - isNavigableFocus
```
public final boolean isNavigableFocus()
```
    Gets whether this map widget is a potential widget that can be focused by navigating using W/A/S/D. If true, this widget can be focused without changing the activated widget. If false, the widget can only be focused by changing the currently activated widget.
    
    If this widget is not isFocusable() this always returns false.
    
    Returns:
    
    True if this widget can be focused by navigating to it
  - isEnabled
```
public final boolean isEnabled()
```
    Gets whether this widget is currently enabled using #setEnabled(enabled). If the parent of this widget is not enabled, this method returns false as well.
    
    Returns:
    
    True if this widget and the parent widgets are enabled
  - setEnabled
```
public final MapWidget setEnabled(boolean enabled)
```
    Sets whether this widget is currently enabled. If a parent of this widget is not enabled, then isEnabled() will continue to return false.
    
    Parameters:
    
    enabled -
    
    Returns:
    
    this widget
  - getWidgets
```
public final List<MapWidget> getWidgets()
```
    Gets an immutable list of children of this widget. These children are drawn on top of this widget. The returned list is guaranteed to be left unmodified when additional children are added or removed from this widget, making it safe to use for iterating.
    
    Returns:
    
    list of children
  - getWidget
```
public final MapWidget getWidget(int index)
```
    Gets a widget stored at a particular index in the list of child widgets. Returns null if no widget is stored at this index.
    
    Parameters:
    
    index -
    
    Returns:
    
    widget at the index
  - getWidgetCount
```
public final int getWidgetCount()
```
    Gets the number of child widgets
    
    Returns:
    
    widget count
  - removeWidget
```
public final void removeWidget()
```
    Removes this widget from its parent. If this widget or a child thereof was previously focused, the focus will automatically switch to the appropriate alternative. This method is equivalent to calling:
```
 widget.getParent().removeWidget(widget);
 
```
  - clearWidgets
```
public void clearWidgets()
```
    Removes all previously added widgets
  - addWidget
```
public final <T extends MapWidget> T addWidget(T widget)
```
    Adds a new child widget to this widget
    
    Parameters:
    
    widget - to add
    
    Returns:
    
    input widget (can be used for chaining calls)
  - swapWidget
```
public final <T extends MapWidget> T swapWidget(MapWidget oldWidget,
                                                T newWidget)
```
    Replaces a widget with a new widget at the exact same index. If the old widget is not contained, the new widget is added instead.
    
    Parameters:
    
    oldWidget - to replace
    
    newWidget - to replace oldWidget with
    
    Returns:
    
    newWidget (for chained calls)
  - removeWidget
```
public final boolean removeWidget(MapWidget widget)
```
    Removes a child widget from this widget. The old area the widget occupied is cleared.
    
    Parameters:
    
    child - to remove
    
    Returns:
    
    True if the child widget was removed
  - clear
```
public final MapWidget clear()
```
    Removes all the displayed contents of this widget
    
    Returns:
    
    this widget
  - invalidate
```
public final void invalidate()
```
    Invalidates the widget, causing it to be redrawn in the future
  - setRetainChildWidgets
```
public final MapWidget setRetainChildWidgets(boolean retain)
```
    Sets whether child widgets are retained when this widget is removed from a parent. When retained, the child widgets are re-added when this widget is re-attached to a parent.
    
    Parameters:
    
    retain - whether to retain the widgets
    
    Returns:
    
    this map widget
  - sendStatusChange
```
public final void sendStatusChange(String name)
```
    Broadcasts a status change to all widgets of the display this widget is attached to
    
    Parameters:
    
    name - of the status change
  - sendStatusChange
```
public final void sendStatusChange(String name,
                                   Object argument)
```
    Broadcasts a status change to all widgets of the display this widget is attached to
    
    Parameters:
    
    name - of the status change
    
    argument - for the status change
  - sendStatusChange
```
public final void sendStatusChange(MapEventPropagation propagationMode,
                                   String name)
```
    Sends a status change to all widgets, the propagation mode defining who receives the status change and in what order.
    
    Parameters:
    
    propagationMode - of sending the status change
    
    name - of the status change
  - sendStatusChange
```
public final void sendStatusChange(MapEventPropagation propagationMode,
                                   String name,
                                   Object argument)
```
    Sends a status change to all widgets, the propagation mode defining who receives the status change and in what order.
    
    Parameters:
    
    propagationMode - of sending the status change
    
    name - of the status change
    
    argument - for the status change
  - performTickUpdates
```
public final void performTickUpdates()
```
    Performs onTick() and onDraw() update operations, and other widget refreshing logic needed to run in the background. Attaches newly added widgets before any updates are performed. This method is called by the internal implementation.
  - setPosition
```
public final MapWidget setPosition(int x,
                                   int y)
```
    Changes the position of this widget relative to the parent
    
    Parameters:
    
    x - - position
    
    y - - position
    
    Returns:
    
    this widget
  - setSize
```
public final MapWidget setSize(int width,
                               int height)
```
    Changes the size of this widget
    
    Parameters:
    
    width -
    
    height -
    
    Returns:
    
    this widget
  - setSize
```
public final MapWidget setSize(Dimension dimension)
```
    Changes the size of this widget
    
    Parameters:
    
    dimension -
    
    Returns:
    
    this widget
  - setBounds
```
public final MapWidget setBounds(int x,
                                 int y,
                                 int width,
                                 int height)
```
    Changes the bounds of this widget
    
    Parameters:
    
    x - - position relative to the parent
    
    y - - position relative to the parent
    
    width -
    
    height -
    
    Returns:
    
    this widget
  - handleNavigation
```
protected void handleNavigation(MapKeyEvent event)
```
    Handles key navigation of the widgets, changing which widgets are focused and activated.
    
    Parameters:
    
    event -
  - navigateNextWidget
```
protected MapWidget navigateNextWidget(List<MapWidget> widgets,
                                       MapPlayerInput.Key key)
```
    Selects the next widget to give focus to after receiving player input to navigate around. Can be overridden to adjust the automatic build-in navigation logic. The method is called for the widget that currently receives focus.
    
    Parameters:
    
    widgets - that can be focused next
    
    key - that was pressed
    
    Returns:
    
    widget to be focused, null to cancel
  - onKey
```
public void onKey(MapKeyEvent event)
```
    Description copied from interface: MapDisplayEvents
    
    Callback function called every tick while a key is pressed down. These callbacks are called before MapDisplayEvents.onTick().
    
    Specified by:
    
    onKey in interface MapDisplayEvents
  - onKeyPressed
```
public void onKeyPressed(MapKeyEvent event)
```
    Description copied from interface: MapDisplayEvents
    
    Callback function called when a key changed from not-pressed to pressed down These callbacks are called before MapDisplayEvents.onTick().
    
    Specified by:
    
    onKeyPressed in interface MapDisplayEvents
  - onKeyReleased
```
public void onKeyReleased(MapKeyEvent event)
```
    Description copied from interface: MapDisplayEvents
    
    Callback function called when a key changed from pressed to not pressed down These callbacks are called before MapDisplayEvents.onTick().
    
    Specified by:
    
    onKeyReleased in interface MapDisplayEvents
  - onLeftClick
```
public void onLeftClick(MapClickEvent event)
```
    Description copied from interface: MapDisplayEvents
    
    Callback function called when a player left-clicks the map held in an item frame showing this Map Display.
    
    Specified by:
    
    onLeftClick in interface MapDisplayEvents
  - onRightClick
```
public void onRightClick(MapClickEvent event)
```
    Description copied from interface: MapDisplayEvents
    
    Callback function called when a player right-clicks the map held in an item frame showing this Map Display.
    
    Specified by:
    
    onRightClick in interface MapDisplayEvents
  - onStatusChanged
```
public void onStatusChanged(MapStatusEvent event)
```
    Description copied from interface: MapDisplayEvents
    
    Callback function called when a widget in the map display wishes to broadcast a status change. These status changes can be used to refresh the map or apply updated configurations.
    
    Specified by:
    
    onStatusChanged in interface MapDisplayEvents
    
    Parameters:
    
    event - of the status change
  - onMapItemChanged
```
public void onMapItemChanged()
```
    Description copied from interface: MapDisplayEvents
    
    Callback function called when the map item of this Map Display changed
    
    Specified by:
    
    onMapItemChanged in interface MapDisplayEvents

Class MapWidget

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

root

parent

display

layer

view

Constructor Detail

MapWidget

Method Detail

onAttached

onDetached

onActivate

onDeactivate

onFocus

onBlur

onTick

onDraw

onBoundsChanged

getParent

getNextInputWidget

setDepthOffset

getX

getY

getWidth

getHeight

getAbsoluteX

getAbsoluteY

getDisplay

isVisible

setVisible

isFocusable

setFocusable

isFocused

focus

isActivated

activate

deactivate

isNavigableFocus

isEnabled

setEnabled

getWidgets

getWidget

getWidgetCount

removeWidget

clearWidgets

addWidget

swapWidget

removeWidget

clear

invalidate

setRetainChildWidgets

sendStatusChange

sendStatusChange

sendStatusChange

sendStatusChange

performTickUpdates

setPosition

setSize

setSize

setBounds

handleNavigation

navigateNextWidget

onKey

onKeyPressed

onKeyReleased

onLeftClick

onRightClick

onStatusChanged

onMapItemChanged