Package limn.components

Enum Class ScrollGutters.Layout

java.lang.Object

java.lang.Enum<ScrollGutters.Layout>

limn.components.ScrollGutters.Layout

All Implemented Interfaces:

Serializable, Comparable<ScrollGutters.Layout>, Constable

Enclosing class:

ScrollGutters

public static enum ScrollGutters.Layout
extends Enum<ScrollGutters.Layout>

Whether a bar floats over the content or takes a strip out of it.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
OVERLAY	Over the content, which keeps the whole box for it.
RESERVED	A strip of the bar's own thickness on whichever axis overflows, with the content narrowed to match, so nothing is ever painted under a bar.

Method Summary

Modifier and Type	Method	Description
static ScrollGutters.Layout	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ScrollGutters.Layout[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OVERLAY

public static final ScrollGutters.Layout OVERLAY

Over the content, which keeps the whole box for it. The default, and the only coherent choice under the fading policies (ScrollBar.Policy.AUTO, ScrollBar.Policy.ON_SCROLL): a strip held open for a bar that is usually not there is dead space. Right for an image, a video, a page of prose: anything that wants every point of width and loses nothing to a bar passing over it.

RESERVED

public static final ScrollGutters.Layout RESERVED

A strip of the bar's own thickness on whichever axis overflows, with the content narrowed to match, so nothing is ever painted under a bar. Right for a table, a form or a tree, where the last column is the one being read. Pair it with ScrollBar.Policy.ALWAYS unless a bar that fades out of an otherwise empty strip is what you want.

Method Details

values

public static ScrollGutters.Layout[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ScrollGutters.Layout valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null