Package io.github.somesourcecode.someguiapi.scene.layout

Class FlowPane

java.lang.Object

io.github.somesourcecode.someguiapi.scene.Node

io.github.somesourcecode.someguiapi.scene.Parent

io.github.somesourcecode.someguiapi.scene.layout.Region

io.github.somesourcecode.someguiapi.scene.layout.Pane

io.github.somesourcecode.someguiapi.scene.layout.FlowPane

public class FlowPane
extends Pane

A layout pane that arranges its children in a flow, wrapping at the pane's bounds.

A horizontal FlowPane (the default) will lay out nodes in rows, wrapping at the width of the pane. A vertical FlowPane will lay out nodes in columns, wrapping at the height of the pane. If the FlowPane has padding set, the nodes will be laid out within those insets.

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
FlowPane()	Constructs a new FlowPane with horizontal orientation.
FlowPane(int hGap, int vGap)	Constructs a new FlowPane with the given horizontal and vertical gaps.
FlowPane(int hGap, int vGap, Node... children)	Constructs a new FlowPane with the given horizontal and vertical gaps and children.
FlowPane(Node... children)	Constructs a new FlowPane with the given children.
FlowPane(Orientation orientation)	Constructs a new FlowPane with the given orientation.
FlowPane(Orientation orientation, int hGap, int vGap)	Constructs a new FlowPane with the given orientation, horizontal and vertical gaps.
FlowPane(Orientation orientation, int hGap, int vGap, Node... children)	Constructs a new FlowPane with the given orientation, horizontal and vertical gaps, and children.
FlowPane(Orientation orientation, Node... children)	Constructs a new FlowPane with the given orientation and children.

Method Summary

Modifier and Type	Method	Description
int	getHGap()	Returns the amount of space between each node in a horizontal FlowPane or the space between each column in a vertical FlowPane.
Orientation	getOrientation()	Returns the orientation of the flow pane.
int	getVGap()	Returns the amount of space between each node in a vertical FlowPane or the space between each row in a horizontal FlowPane.
protected void	layoutChildren()
void	setHGap(int hGap)	Sets the amount of space between each node in a horizontal FlowPane or the space between each column in a vertical FlowPane.
void	setOrientation(Orientation orientation)	Sets the orientation of the flow pane.
void	setVGap(int vGap)	Sets the amount of space between each node in a vertical FlowPane or the space between each row in a horizontal FlowPane.

Methods inherited from class io.github.somesourcecode.someguiapi.scene.layout.Pane

getChildren

Methods inherited from class io.github.somesourcecode.someguiapi.scene.layout.Region

getHeight, getPadding, getWidth, resize, resizeRelocate, setHeight, setPadding, setWidth

Methods inherited from class io.github.somesourcecode.someguiapi.scene.Parent

getBackground, isSceneRoot, layout, lookup, lookupAll, needsLayout, nodeAt, renderPixelAt, requestLayout, setBackground

Methods inherited from class io.github.somesourcecode.someguiapi.scene.Node

getId, getLayoutX, getLayoutY, getOnClick, getOnHotBarClick, getOnLeftClick, getOnRightClick, getOnShiftClick, getParent, getScene, getTranslateX, getTranslateY, isClipping, isVisible, lookupAll, relocate, requestParentLayout, setClipping, setId, setLayoutX, setLayoutY, setOnClick, setOnHotBarClick, setOnLeftClick, setOnRightClick, setOnShiftClick, setTranslateX, setTranslateY, setVisible

Methods inherited from class java.lang.Object

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

Constructor Details

FlowPane

public FlowPane()

Constructs a new FlowPane with horizontal orientation.

Since:

1.0.0

FlowPane

public FlowPane(Orientation orientation)

Constructs a new FlowPane with the given orientation.

Parameters:

orientation - the orientation of the flow pane

Since:

1.0.0

FlowPane

public FlowPane(int hGap,
 int vGap)

Constructs a new FlowPane with the given horizontal and vertical gaps.

Parameters:

hGap - the horizontal gap between nodes

vGap - the vertical gap between nodes

Since:

1.0.0

FlowPane

public FlowPane(Orientation orientation,
 int hGap,
 int vGap)

Constructs a new FlowPane with the given orientation, horizontal and vertical gaps.

Parameters:

orientation - the orientation of the flow pane

hGap - the horizontal gap between nodes

vGap - the vertical gap between nodes

Since:

1.0.0

FlowPane

public FlowPane(Node... children)

Constructs a new FlowPane with the given children.

Parameters:

children - the children of the flow pane

Since:

1.0.0

FlowPane

public FlowPane(Orientation orientation,
 Node... children)

Constructs a new FlowPane with the given orientation and children.

Parameters:

orientation - the orientation of the flow pane

children - the children of the flow pane

Since:

1.0.0

FlowPane

public FlowPane(int hGap,
 int vGap,
 Node... children)

Constructs a new FlowPane with the given horizontal and vertical gaps and children.

Parameters:

hGap - the horizontal gap between nodes

vGap - the vertical gap between nodes

children - the children of the flow pane

Since:

1.0.0

FlowPane

public FlowPane(Orientation orientation,
 int hGap,
 int vGap,
 Node... children)

Constructs a new FlowPane with the given orientation, horizontal and vertical gaps, and children.

Parameters:

orientation - the orientation of the flow pane

hGap - the horizontal gap between nodes

vGap - the vertical gap between nodes

children - the children of the flow pane

Since:

1.0.0

Method Details

getOrientation

public Orientation getOrientation()

Returns the orientation of the flow pane.

Returns:

the orientation of the flow pane

Since:

1.0.0

setOrientation

public void setOrientation(Orientation orientation)

Sets the orientation of the flow pane.

Parameters:

orientation - the orientation of the flow pane

Since:

1.0.0

getHGap

public int getHGap()

Returns the amount of space between each node in a horizontal FlowPane or the space between each column in a vertical FlowPane.

Returns:

the horizontal gap between nodes

Since:

1.0.0

setHGap

public void setHGap(int hGap)

Sets the amount of space between each node in a horizontal FlowPane or the space between each column in a vertical FlowPane.

Parameters:

hGap - the horizontal gap between nodes

Since:

1.0.0

getVGap

public int getVGap()

Returns the amount of space between each node in a vertical FlowPane or the space between each row in a horizontal FlowPane.

Returns:

the vertical gap between nodes

Since:

1.0.0

setVGap

public void setVGap(int vGap)

Sets the amount of space between each node in a vertical FlowPane or the space between each row in a horizontal FlowPane.

Parameters:

vGap - the vertical gap between nodes

Since:

1.0.0

layoutChildren

protected void layoutChildren()

Overrides:

layoutChildren in class Parent