Package org.zkoss.stateless.sul

Interface IDoublespinner

All Superinterfaces:

IAnyGroup<IDoublespinner>, IChildrenOfInputgroup<IDoublespinner>, IComponent<IDoublespinner>, IFormatInputElement<IDoublespinner,java.lang.Double>, IHtmlBasedComponent<IDoublespinner>, IInputElement<IDoublespinner,java.lang.Double>, INumberInputElement<IDoublespinner,java.lang.Double>, IReadonly<IDoublespinner>, IXulElement<IDoublespinner>

public interface IDoublespinner
extends INumberInputElement<IDoublespinner,java.lang.Double>, IAnyGroup<IDoublespinner>

Immutable Doublespinner component.

An edit box for holding a constrained double.

Constraint

You could specify what value to accept for input controls by use of the constraint attribute. It could be a combination of no empty and the min (minimum) and max (maximum) to doublespinner.}.

For example,

 
 IDoublespinner.ofConstraint("no empty, min -2.5 max 6.5: between -2.5 to 6.5");
 
 

Author:

katherine

See Also:

Doublespinner

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IDoublespinner.Builder	Builds instances of type IDoublespinner.
static class	IDoublespinner.Updater	Builds an updater of type IDoublespinner for UiAgent.smartUpdate(Locator, SmartUpdater).

Field Summary

Fields

Modifier and Type	Field	Description
static IDoublespinner	DEFAULT	Constant for default attributes of this immutable component.

Method Summary

Modifier and Type	Method	Description
default double	getStep()	Returns the step of doublespinner
default java.lang.String	getWidgetClass()	Returns the client widget class.
default boolean	isButtonVisible()	Returns whether the button (on the right of the doublespinner) is visible.
static IDoublespinner	of(double value)	Returns the instance with the given value.
static IDoublespinner	of(java.lang.Double value)	Returns the instance with the given value.
static IDoublespinner	ofCols(int cols)	Returns the instance with the given cols.
static IDoublespinner	ofConstraint(java.lang.String constraint)	Returns the instance with the given constraint.
static IDoublespinner	ofId(java.lang.String id)	Returns the instance with the given id.
IDoublespinner	withButtonVisible(boolean buttonVisible)	Returns a copy of this immutable component with the specified buttonVisible.
IDoublespinner	withStep(double step)	Returns a copy of this immutable component with the specified step.
IDoublespinner	withValue(java.lang.Double value)	Returns a copy of this immutable component with the specified value.

Methods inherited from interface org.zkoss.stateless.sul.IComponent

getAction, getActions, getClientAttributes, getId, getMold, getWidgetListeners, getWidgetOverrides, isVisible, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withActions, withActions, withClientAttribute, withClientAttributes, withId, withMold, withVisible, withWidgetClass, withWidgetListener, withWidgetListeners, withWidgetOverride, withWidgetOverrides

Methods inherited from interface org.zkoss.stateless.sul.IFormatInputElement

getFormat, withFormat

Methods inherited from interface org.zkoss.stateless.sul.IHtmlBasedComponent

getClientAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZIndex, isFocus, withClientAction, withDraggable, withDroppable, withFocus, withHeight, withHflex, withLeft, withRenderdefer, withSclass, withStyle, withTabindex, withTabindex, withTooltiptext, withTop, withVflex, withWidth, withZclass, withZIndex

Methods inherited from interface org.zkoss.stateless.sul.IInputElement

getConstraint, getErrorboxIconSclass, getErrorboxSclass, getErrorMessage, getInputAttributes, getInstant, getMaxlength, getName, getPlaceholder, getValue, isDisabled, isInplace, withCols, withConstraint, withDisabled, withErrorboxIconSclass, withErrorboxSclass, withErrorMessage, withInplace, withInputAttributes, withInstant, withMaxlength, withName, withPlaceholder

Methods inherited from interface org.zkoss.stateless.sul.INumberInputElement

getCols, getLocale, getRoundingMode, withLocale, withLocale, withRoundingMode

Methods inherited from interface org.zkoss.stateless.sul.IReadonly

isReadonly, withReadonly

Methods inherited from interface org.zkoss.stateless.sul.IXulElement

getContext, getCtrlKeys, getPopup, getTooltip, withContext, withCtrlKeys, withPopup, withTooltip

Field Detail

DEFAULT

static final IDoublespinner DEFAULT

Constant for default attributes of this immutable component.

Method Detail

withValue

IDoublespinner withValue(java.lang.Double value)

Description copied from interface: IInputElement

Returns a copy of this immutable component with the specified value.

Sets the value of the input component.

Specified by:

withValue in interface IInputElement<IDoublespinner,java.lang.Double>

Parameters:

value - The value of the input component.

Default: null.

Returns:

A modified copy of the this object

getWidgetClass

default java.lang.String getWidgetClass()

Returns the client widget class.

Default: "zul.inp.Doublespinner"

Specified by:

getWidgetClass in interface IComponent<IDoublespinner>

getStep

default double getStep()

Returns the step of doublespinner

Default: 1.0

withStep

IDoublespinner withStep(double step)

Returns a copy of this immutable component with the specified step.

Sets the step of doublespinner

Parameters:

step - The step of the doublespinner

Default: 1.0.

Returns:

A modified copy of the this object

isButtonVisible

default boolean isButtonVisible()

Returns whether the button (on the right of the doublespinner) is visible.

Default: true.

withButtonVisible

IDoublespinner withButtonVisible(boolean buttonVisible)

Returns a copy of this immutable component with the specified buttonVisible.

Sets whether the button (on the right of the doublespinner) is visible.

Parameters:

buttonVisible - false to disable the button visibility.

Default: true.

Returns:

A modified copy of the this object

of

static IDoublespinner of(java.lang.Double value)

Returns the instance with the given value.

Parameters:

value - The double value of the spinner

of

static IDoublespinner of(double value)

Returns the instance with the given value.

Parameters:

value - The double value of the spinner

ofCols

static IDoublespinner ofCols(int cols)

Returns the instance with the given cols.

Parameters:

cols - The cols which determines the visible width

ofConstraint

static IDoublespinner ofConstraint(java.lang.String constraint)

Returns the instance with the given constraint.

Parameters:

constraint - The doublespinner constraint

ofId

static IDoublespinner ofId(java.lang.String id)

Returns the instance with the given id.

Parameters:

id - The id to identify this component