com.lukflug.panelstudio.layout

Class CSGOLayout

java.lang.Object

com.lukflug.panelstudio.layout.CSGOLayout

All Implemented Interfaces:

IScrollSize, ILayout

public class CSGOLayout
extends java.lang.Object
implements ILayout, IScrollSize

Adds components in a tab-based layout.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.function.Supplier<Animation>	animation The animation supplier.
protected ChildUtil.ChildMode	colorType The child mode to use for setting components that are containers (e.g. color components).
protected java.lang.String	enabledButton The title for module toggles.
protected boolean	horizontal Whether tab list is horizontal.
protected ILabeled	label The panel label.
protected boolean	moduleColumn Whether settings are in a separate column.
protected java.awt.Point	position The panel position.
protected ChildUtil	util The child util instance.
protected int	weight The weight of the settings column.
protected int	width The panel width.

Constructor Summary

Constructors

Constructor and Description
CSGOLayout(ILabeled label, java.awt.Point position, int width, int popupWidth, java.util.function.Supplier<Animation> animation, java.lang.String enabledButton, boolean horizontal, boolean moduleColumn, int weight, ChildUtil.ChildMode colorType, PopupTuple popupType) Constructor.

Method Summary

Modifier and Type	Method and Description
protected <T extends IComponent> IEnumSetting	addContainer(ILabeled label, java.util.stream.Stream<ILabeled> labels, IContainer<T> window, ThemeTuple theme, boolean horizontal, java.util.function.Function<RadioButton,T> container, IBoolean visible) Add a multiplexing radio button list to a parent container.
protected <T> void	addSettingsComponent(ISetting<T> setting, VerticalContainer container, IComponentAdder gui, IComponentGenerator components, ThemeTuple theme) Add a setting component.
protected boolean	isDownKey(int key) Keyboard predicate for navigating down.
protected boolean	isLeftKey(int key) Keyboard predicate for navigating left.
protected boolean	isRightKey(int key) Keyboard predicate for navigating right.
protected boolean	isUpKey(int key) Keyboard predicate for navigating up.
void	populateGUI(IComponentAdder gui, IComponentGenerator components, IClient client, ITheme theme) Populates a GUI with modules and settings given.
protected HorizontalComponent<ScrollBarComponent<java.lang.Void,IComponent>>	wrapColumn(IComponent button, ThemeTuple theme, int weight) Wrap content in a scrollable horizontal component to be added as a column.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.lukflug.panelstudio.component.IScrollSize

getComponentWidth, getScrollHeight

Field Detail

label

protected ILabeled label

The panel label.

position

protected java.awt.Point position

The panel position.

width

protected int width

The panel width.

animation

protected java.util.function.Supplier<Animation> animation

The animation supplier.

enabledButton

protected java.lang.String enabledButton

The title for module toggles.

horizontal

protected boolean horizontal

Whether tab list is horizontal.

moduleColumn

protected boolean moduleColumn

Whether settings are in a separate column.

weight

protected int weight

The weight of the settings column.

colorType

protected ChildUtil.ChildMode colorType

The child mode to use for setting components that are containers (e.g. color components).

util

protected ChildUtil util

The child util instance.

Constructor Detail

CSGOLayout

public CSGOLayout(ILabeled label,
                  java.awt.Point position,
                  int width,
                  int popupWidth,
                  java.util.function.Supplier<Animation> animation,
                  java.lang.String enabledButton,
                  boolean horizontal,
                  boolean moduleColumn,
                  int weight,
                  ChildUtil.ChildMode colorType,
                  PopupTuple popupType)

Constructor.

Parameters:

label - panel label

position - panel position

width - panel width

popupWidth - pop-up width

animation - animation supplier

enabledButton - title for module toggles

horizontal - whether tab list is horizontal

moduleColumn - whether settings are in a separate column

weight - weight of the module column

colorType - child mode to use for setting components that are containers (e.g. color components)

popupType - child util instance

Method Detail

populateGUI

public void populateGUI(IComponentAdder gui,
                        IComponentGenerator components,
                        IClient client,
                        ITheme theme)

Description copied from interface: ILayout

Populates a GUI with modules and settings given.

Specified by:

populateGUI in interface ILayout

Parameters:

gui - the GUI to populate

components - the setting widgets to use

client - the client defining the module and setting hierarchy

theme - the theme to be used

addSettingsComponent

protected <T> void addSettingsComponent(ISetting<T> setting,
                                        VerticalContainer container,
                                        IComponentAdder gui,
                                        IComponentGenerator components,
                                        ThemeTuple theme)

Add a setting component.

Type Parameters:

T - the setting state type

Parameters:

setting - the setting to be added

container - the parent container

gui - the component adder for pop-ups

components - the component generator

theme - the theme to be used

addContainer

protected <T extends IComponent> IEnumSetting addContainer(ILabeled label,
                                                           java.util.stream.Stream<ILabeled> labels,
                                                           IContainer<T> window,
                                                           ThemeTuple theme,
                                                           boolean horizontal,
                                                           java.util.function.Function<RadioButton,T> container,
                                                           IBoolean visible)

Add a multiplexing radio button list to a parent container.

Type Parameters:

T - parent container component type

Parameters:

label - the radio button label

labels - list of items to multiplex

window - the parent container

theme - the theme to be used

horizontal - whether radio button is horizontal

container - mapping from radio button to container component type instance

visible - radio buttons visibility predicate

Returns:

the enum setting controlling the radio button list

wrapColumn

protected HorizontalComponent<ScrollBarComponent<java.lang.Void,IComponent>> wrapColumn(IComponent button,
                                                                                        ThemeTuple theme,
                                                                                        int weight)

Wrap content in a scrollable horizontal component to be added as a column.

Parameters:

button - the content container

theme - the theme to be used

weight - the horizontal weight

Returns:

a horizontal component

isUpKey

protected boolean isUpKey(int key)

Keyboard predicate for navigating up.

Parameters:

key - the key scancode

Returns:

whether key matches

isDownKey

protected boolean isDownKey(int key)

Keyboard predicate for navigating down.

Parameters:

key - the key scancode

Returns:

whether key matches

isLeftKey

protected boolean isLeftKey(int key)

Keyboard predicate for navigating left.

Parameters:

key - the key scancode

Returns:

whether key matches

isRightKey

protected boolean isRightKey(int key)

Keyboard predicate for navigating right.

Parameters:

key - the key scancode

Returns:

whether key matches