Package org.gnome.adw

Class WrapLayout.Builder<B extends WrapLayout.Builder<B>>

java.lang.Object

org.javagi.gobject.Builder<B>

org.gnome.gobject.GObject.Builder<B>

org.gnome.gtk.LayoutManager.Builder<B>

org.gnome.adw.WrapLayout.Builder<B>

Type Parameters:

B - the type of the Builder that is returned

All Implemented Interfaces:

Orientable.Builder<B>, BuilderInterface

Enclosing class:

WrapLayout

public static class WrapLayout.Builder<B extends WrapLayout.Builder<B>>
extends LayoutManager.Builder<B>
implements Orientable.Builder<B>

Inner class implementing a builder pattern to construct a GObject with properties.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Default constructor for a Builder object.

Method Summary

Modifier and Type	Method	Description
WrapLayout	build()	Finish building the WrapLayout object.
B	setAlign(float align)	The alignment of the children within each line.
B	setChildSpacing(int childSpacing)	The spacing between widgets on the same line.
B	setChildSpacingUnit(LengthUnit childSpacingUnit)	The length unit for child spacing.
B	setJustify(JustifyMode justify)	Determines whether and how each complete line should be stretched to fill the entire widget.
B	setJustifyLastLine(boolean justifyLastLine)	Whether the last line should be stretched to fill the entire widget.
B	setLineHomogeneous(boolean lineHomogeneous)	Whether all lines should take the same amount of space.
B	setLineSpacing(int lineSpacing)	The spacing between lines.
B	setLineSpacingUnit(LengthUnit lineSpacingUnit)	The length unit for line spacing.
B	setNaturalLineLength(int naturalLineLength)	Determines the natural size for each line.
B	setNaturalLineLengthUnit(LengthUnit naturalLineLengthUnit)	The length unit for natural line length.
B	setPackDirection(PackDirection packDirection)	The direction children are packed in each line.
B	setWrapPolicy(WrapPolicy wrapPolicy)	The policy for line wrapping.
B	setWrapReverse(boolean wrapReverse)	Whether wrap direction should be reversed.

Methods inherited from class org.gnome.gobject.GObject.Builder

onNotify

Methods inherited from class org.javagi.gobject.Builder

addBuilderProperty, connect, connect, connectSignals, getArena, getNames, getValues

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.javagi.gobject.BuilderInterface

addBuilderProperty, connect, connect, getArena

Methods inherited from interface org.gnome.gtk.Orientable.Builder

setOrientation

Constructor Details

Builder

protected Builder()

Default constructor for a Builder object.

Method Details

build

public WrapLayout build()

Finish building the WrapLayout object. This will call GObject.withProperties(org.gnome.glib.Type, java.lang.String[], org.gnome.gobject.Value[]) to create a new GObject instance, which is then cast to WrapLayout.

Overrides:

build in class LayoutManager.Builder<B extends WrapLayout.Builder<B>>

Returns:

a new instance of WrapLayout with the properties that were set in the Builder object.

setAlign

public B setAlign(float align)

The alignment of the children within each line.

0 means the children are placed at the start of the line, 1 means they are placed at the end of the line. 0.5 means they are placed in the middle of the line.

Alignment is only used when WrapLayout:justify is set to ADW_JUSTIFY_NONE, or on the last line when the WrapLayout:justify-last-line is FALSE.

Parameters:

align - the value for the align property

Returns:

the Builder instance is returned, to allow method chaining

Since:

1.7

setChildSpacing

public B setChildSpacing(int childSpacing)

The spacing between widgets on the same line.

See WrapLayout:child-spacing-unit.

Parameters:

childSpacing - the value for the child-spacing property

Returns:

the Builder instance is returned, to allow method chaining

Since:

1.7

setChildSpacingUnit

public B setChildSpacingUnit(LengthUnit childSpacingUnit)

The length unit for child spacing.

Allows the spacing to vary depending on the text scale factor.

See WrapLayout:child-spacing.

Parameters:

childSpacingUnit - the value for the child-spacing-unit property

Returns:

the Builder instance is returned, to allow method chaining

Since:

1.7

setJustify

public B setJustify(JustifyMode justify)

Determines whether and how each complete line should be stretched to fill the entire widget.

If set to ADW_JUSTIFY_FILL, each widget in the line will be stretched, keeping consistent spacing, so that the line fills the entire widget.

If set to ADW_JUSTIFY_SPREAD, the spacing between widgets will be increased, keeping widget sizes intact. The first and last widget will be aligned with the beginning and end of the line. If the line only contains a single widget, it will be stretched regardless.

If set to ADW_JUSTIFY_NONE, the line will not be stretched and the children will be placed together within the line, according to WrapLayout:align.

By default this doesn't affect the last line, as it will be incomplete. Use WrapLayout:justify-last-line to justify it as well.

Parameters:

justify - the value for the justify property

Returns:

the Builder instance is returned, to allow method chaining

Since:

1.7

setJustifyLastLine

public B setJustifyLastLine(boolean justifyLastLine)

Whether the last line should be stretched to fill the entire widget.

See WrapLayout:justify.

Parameters:

justifyLastLine - the value for the justify-last-line property

Returns:

the Builder instance is returned, to allow method chaining

Since:

1.7

setLineHomogeneous

public B setLineHomogeneous(boolean lineHomogeneous)

Whether all lines should take the same amount of space.

Parameters:

lineHomogeneous - the value for the line-homogeneous property

Returns:

the Builder instance is returned, to allow method chaining

Since:

1.7

setLineSpacing

public B setLineSpacing(int lineSpacing)

The spacing between lines.

See WrapLayout:line-spacing-unit.

Parameters:

lineSpacing - the value for the line-spacing property

Returns:

the Builder instance is returned, to allow method chaining

Since:

1.7

setLineSpacingUnit

public B setLineSpacingUnit(LengthUnit lineSpacingUnit)

The length unit for line spacing.

Allows the spacing to vary depending on the text scale factor.

See WrapLayout:line-spacing.

Parameters:

lineSpacingUnit - the value for the line-spacing-unit property

Returns:

the Builder instance is returned, to allow method chaining

Since:

1.7

setNaturalLineLength

public B setNaturalLineLength(int naturalLineLength)

Determines the natural size for each line.

It should be used to limit the line lengths, for example when used in popovers.

See WrapLayout:natural-line-length-unit.

Parameters:

naturalLineLength - the value for the natural-line-length property

Returns:

the Builder instance is returned, to allow method chaining

Since:

1.7

setNaturalLineLengthUnit

public B setNaturalLineLengthUnit(LengthUnit naturalLineLengthUnit)

The length unit for natural line length.

Allows the length to vary depending on the text scale factor.

See WrapLayout:natural-line-length.

Parameters:

naturalLineLengthUnit - the value for the natural-line-length-unit property

Returns:

the Builder instance is returned, to allow method chaining

Since:

1.7

setPackDirection

public B setPackDirection(PackDirection packDirection)

The direction children are packed in each line.

Parameters:

packDirection - the value for the pack-direction property

Returns:

the Builder instance is returned, to allow method chaining

Since:

1.7

setWrapPolicy

public B setWrapPolicy(WrapPolicy wrapPolicy)

The policy for line wrapping.

If set to ADW_WRAP_NATURAL, the box will wrap to the next line as soon as the previous line cannot fit any more children without shrinking them past their natural size.

If set to ADW_WRAP_MINIMUM, the box will try to fit as many children into each line as possible, shrinking them down to their minimum size before wrapping to the next line.

Parameters:

wrapPolicy - the value for the wrap-policy property

Returns:

the Builder instance is returned, to allow method chaining

Since:

1.7

setWrapReverse

public B setWrapReverse(boolean wrapReverse)

Whether wrap direction should be reversed.

By default, lines wrap downwards in a horizontal box, and towards the end in a vertical box. If set to TRUE, they wrap upwards or towards the start respectively.

Parameters:

wrapReverse - the value for the wrap-reverse property

Returns:

the Builder instance is returned, to allow method chaining

Since:

1.7