Package com.spinyowl.legui.component

Class Layer

java.lang.Object

com.spinyowl.legui.component.Component

com.spinyowl.legui.component.Layer

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Dialog.DialogLayer, SelectBox.SelectBoxLayer

public class Layer
extends Component

Layer one of base structures. Holds layer containers which are used to hold all of other components.

Layer can be eventPassable - that's mean that current layer allow to pass events to bottom layer if event wasn't handled by components of this layer.

Also layer can be eventReceivable - that's mean that current layer and all of it components can receive events. For example tooltip layer is eventPassable and isn't eventReceivable.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Layer()	Default constructor.

Method Summary

Modifier and Type	Method	Description
Frame	getFrame()	Returns frame to which attached this layer.
boolean	isEventPassable()	Returns true if layer is event passable.
boolean	isEventReceivable()	Returns true if layer is event receivable.
void	setEventPassable(boolean eventPassable)	Used to enable or disable passing events to bottom layer.
void	setEventReceivable(boolean eventReceivable)	Used to enable or disable receiving events by layer.
protected void	setFrame(Frame frame)	Used to attach layer to frame.

Methods inherited from class com.spinyowl.legui.component.Component

add, add, addAll, clearChildComponents, containerIterator, contains, containsAll, count, equals, forEach, getAbsolutePosition, getChildComponents, getFocusedStyle, getHoveredStyle, getIntersector, getLayer, getListenerMap, getMetadata, getParent, getPosition, getPressedStyle, getSize, getStyle, getTabIndex, getTooltip, hashCode, indexOfChild, intersects, isEmpty, isEnabled, isFocusable, isFocused, isHovered, isPressed, isTabFocusable, isVisible, keepRendering, keepRendering, parallelStream, remove, remove, removeAll, removeIf, setEnabled, setFocusable, setFocused, setHovered, setIntersector, setListenerMap, setParent, setPosition, setPosition, setPressed, setSize, setSize, setStyle, setTabFocusable, setTabIndex, setTooltip, stream, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Layer

public Layer()

Default constructor. Used to create component instance without any parameters.

Also if you want to make it easy to use with Json marshaller/unmarshaller component should contain empty constructor.

Method Details

getFrame

public Frame getFrame()

Returns frame to which attached this layer.

Overrides:

getFrame in class Component

Returns:

frame to which attached this layer.

setFrame

protected void setFrame(Frame frame)

Used to attach layer to frame.

Parameters:

frame - frame to attach.

isEventPassable

public boolean isEventPassable()

Returns true if layer is event passable.

Returns:

true if layer is event passable.

setEventPassable

public void setEventPassable(boolean eventPassable)

Used to enable or disable passing events to bottom layer.

Parameters:

eventPassable - true/false to enable/disable passing events to bottom layer.

isEventReceivable

public boolean isEventReceivable()

Returns true if layer is event receivable.

Returns:

true if layer is event receivable.

setEventReceivable

public void setEventReceivable(boolean eventReceivable)

Used to enable or disable receiving events by layer.

Parameters:

eventReceivable - true/false to enable/disable receiving events by layer.