me.leoko.advancedgui.utils.components

Class ViewComponent

java.lang.Object

me.leoko.advancedgui.utils.components.Component

me.leoko.advancedgui.utils.components.AdaptiveComponent

me.leoko.advancedgui.utils.components.ViewComponent

All Implemented Interfaces:

org.bukkit.event.Listener

public class ViewComponent
extends AdaptiveComponent

The ViewComponent provides an easy way to display different components to different interactions.

Field Summary

Fields inherited from class me.leoko.advancedgui.utils.components.AdaptiveComponent

component

Fields inherited from class me.leoko.advancedgui.utils.components.Component

clickAction, hidden, id, interaction

Constructor Summary

Constructors

Constructor and Description
ViewComponent(String id, Action clickAction, boolean hidden, Interaction interaction, Component defaultComponent, List<Component> views) Instantiates a new ViewComponent.

Method Summary

Modifier and Type	Method and Description
ViewComponent	clone(Interaction interaction) Clone the component with the new interaction.
Component	locate(String componentId) Locate the component with the given id.
ViewComponent	locateOn(Interaction interaction) Locate the same component on a different interaction.
void	setView(String componentId) Changes the view of the given interaction to the component with the provided id.

Methods inherited from class me.leoko.advancedgui.utils.components.AdaptiveComponent

adapt, apply, getState, isInBounds, onClick

Methods inherited from class me.leoko.advancedgui.utils.components.Component

dispose, getClickAction, getId, getInteraction, isHidden, locate, setClickAction, setHidden

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewComponent

public ViewComponent(String id,
                     Action clickAction,
                     boolean hidden,
                     Interaction interaction,
                     Component defaultComponent,
                     List<Component> views)

Instantiates a new ViewComponent.

Parameters:

id - the id

clickAction - the click actions

hidden - the hidden

interaction - the interaction

defaultComponent - the default component

views - the views

Method Detail

setView

public void setView(String componentId)

Changes the view of the given interaction to the component with the provided id.

Parameters:

componentId - the component id

clone

public ViewComponent clone(Interaction interaction)

Description copied from class: Component

Clone the component with the new interaction. Used to copy component tree when initializing new interactions.

Overrides:

clone in class AdaptiveComponent

Parameters:

interaction - the interaction

Returns:

the component

locateOn

public ViewComponent locateOn(Interaction interaction)

Description copied from class: Component

Locate the same component on a different interaction.
In most cases return value can safely be casted to concrete component class.
Alias for:
interaction.getComponentTree().locate(component.getId())

Overrides:

locateOn in class AdaptiveComponent

Parameters:

interaction - the interaction

Returns:

the component

locate

public Component locate(String componentId)

Description copied from class: Component

Locate the component with the given id. If this component contains other components then it should search on those as well.

Overrides:

locate in class Component

Parameters:

componentId - the component id

Returns:

the component