Package me.hackware.api.setting.impl

Class NumberSetting<N extends Number & Comparable<N>>

java.lang.Object

me.hackware.api.setting.Setting<N>

me.hackware.api.setting.impl.NumberSetting<N>

public class NumberSetting<N extends Number & Comparable<N>>
extends Setting<N>

Field Summary

Fields inherited from class me.hackware.api.setting.Setting

value

Constructor Summary

Constructors

Constructor	Description
NumberSetting(String name)
NumberSetting(String name, String description)
NumberSetting(String name, String description, N defaultValue)
NumberSetting(String name, N defaultValue)

Method Summary

Modifier and Type	Method	Description
NumberSetting<N>	commitOnRelease()	Slider drags preview live but only commit the value on mouse release.
NumberSetting<N>	defaultValue(N defaultValue)
NumberSetting<N>	description(String description)
NumberSetting<N>	displayName(String displayName)
double	doubleValue()	Convenience accessors returning primitives for UI / arithmetic.
NumberSetting<N>	fractional()	Enables fractional snapping/display (GUI-scale-aware fractions like 2/3).
NumberSetting<N>	fractional(boolean fractional)
N	getMax()
N	getMin()
double[]	getSnapValues()	Current allowed snap values, or null if unconstrained.
N	getStep()
String	getSuffix()
NumberSetting<N>	group(String group)
boolean	isCommitOnRelease()
boolean	isFractional()
NumberSetting<N>	max(N max)
double	maxDouble()
NumberSetting<N>	min(N min)
double	minDouble()
NumberSetting<N>	onChanged(Runnable callback)
NumberSetting<N>	range(N min, N max)
void	setFromDouble(double d)	Sets the value from a double primitive (used by UI sliders).
void	setValue(N value)
double	snap(double v)	Nearest allowed snap value to v (returns v unchanged if no snap set).
NumberSetting<N>	snapValues(Supplier<double[]> snapValues)	Snap the value to the nearest of this dynamic set (evaluated live) instead of the step grid.
NumberSetting<N>	step(N step)
double	stepDouble()
NumberSetting<N>	suffix(String suffix)	Appends a unit to the displayed value (e.g.
NumberSetting<N>	visible(boolean visible)
NumberSetting<N>	visible(BooleanSupplier visible)

Methods inherited from class me.hackware.api.setting.Setting

get, getDefaultValue, getDescription, getDisplayName, getGroup, getName, getOwner, isBulkLoading, isVisible, setBulkLoadProbe, setOwner

Methods inherited from class java.lang.Object

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

Constructor Details

NumberSetting

public NumberSetting(String name)

NumberSetting

public NumberSetting(String name,
 String description)

NumberSetting

public NumberSetting(String name,
 N defaultValue)

NumberSetting

public NumberSetting(String name,
 String description,
 N defaultValue)

Method Details

min

public NumberSetting<N> min(N min)

max

public NumberSetting<N> max(N max)

step

public NumberSetting<N> step(N step)

range

public NumberSetting<N> range(N min,
 N max)

suffix

public NumberSetting<N> suffix(String suffix)

Appends a unit to the displayed value (e.g. "x").

fractional

public NumberSetting<N> fractional()

Enables fractional snapping/display (GUI-scale-aware fractions like 2/3).

fractional

public NumberSetting<N> fractional(boolean fractional)

commitOnRelease

public NumberSetting<N> commitOnRelease()

Slider drags preview live but only commit the value on mouse release.

snapValues

public NumberSetting<N> snapValues(Supplier<double[]> snapValues)

Snap the value to the nearest of this dynamic set (evaluated live) instead of the step grid.

displayName

public NumberSetting<N> displayName(String displayName)

Overrides:

displayName in class Setting<N extends Number & Comparable<N>>

defaultValue

public NumberSetting<N> defaultValue(N defaultValue)

Overrides:

defaultValue in class Setting<N extends Number & Comparable<N>>

description

public NumberSetting<N> description(String description)

Overrides:

description in class Setting<N extends Number & Comparable<N>>

group

public NumberSetting<N> group(String group)

Overrides:

group in class Setting<N extends Number & Comparable<N>>

visible

public NumberSetting<N> visible(boolean visible)

Overrides:

visible in class Setting<N extends Number & Comparable<N>>

visible

public NumberSetting<N> visible(BooleanSupplier visible)

Overrides:

visible in class Setting<N extends Number & Comparable<N>>

onChanged

public NumberSetting<N> onChanged(Runnable callback)

Overrides:

onChanged in class Setting<N extends Number & Comparable<N>>

getMin

public N getMin()

getMax

public N getMax()

getStep

public N getStep()

getSuffix

public String getSuffix()

isFractional

public boolean isFractional()

isCommitOnRelease

public boolean isCommitOnRelease()

getSnapValues

public double[] getSnapValues()

Current allowed snap values, or null if unconstrained.

snap

public double snap(double v)

Nearest allowed snap value to v (returns v unchanged if no snap set).

doubleValue

public double doubleValue()

Convenience accessors returning primitives for UI / arithmetic.

minDouble

public double minDouble()

maxDouble

public double maxDouble()

stepDouble

public double stepDouble()

setValue

public void setValue(N value)

Overrides:

setValue in class Setting<N extends Number & Comparable<N>>

setFromDouble

public void setFromDouble(double d)

Sets the value from a double primitive (used by UI sliders).