Spinner (Minis 6.16.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.wicketstuff.minis.behavior.spinner
Class Spinner

java.lang.Object
  org.apache.wicket.behavior.Behavior
      org.wicketstuff.minis.behavior.spinner.Spinner

All Implemented Interfaces:: Serializable, IComponentAwareEventSink, IComponentAwareHeaderContributor, IClusterable

public class Spinner
extends Behavior
extends Behavior

This behavior is used to augment a TextField with spinning abilities.
For customization of the Spinner take a look at the configure(Properties) method.

Author:: Gerolf Seitz
See Also:: Serialized Form

Constructor Summary
`Spinner()`

Method Summary
`void`	`afterRender(Component component)`
`void`	`beforeRender(Component component)`
`void`	`bind(Component component)`
`protected void`	`configure(Properties p)` This method can be overridden to customize the Spinner. The following options are used by the Spinner: interval The amount to increment (default=1) round The number of decimal points to which to round (default=0) min The lowest allowed value, false for no min (default=false) max The highest allowed value, false for no max (default=false) prefix String to prepend when updating (default='') suffix String to append when updating (default='') data An array giving a list of items through which to iterate onIncrement Function to call after incrementing onDecrement Function to call after decrementing afterUpdate Function to call after update of the value onStop Function to call on click or mouseup (default=false)
`protected Component`	`getSpinDownComponent()`
`protected Component`	`getSpinUpComponent()`
`void`	`renderHead(Component c, org.apache.wicket.markup.head.IHeaderResponse response)`

Methods inherited from class org.apache.wicket.behavior.Behavior
`canCallListenerInterface, detach, getStatelessHint, isEnabled, isTemporary, onComponentTag, onConfigure, onEvent, onException, onRemove, unbind`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

Spinner

public Spinner()

Method Detail

beforeRender

public void beforeRender(Component component)

Overrides:: beforeRender in class Behavior

bind

public void bind(Component component)

Overrides:: bind in class Behavior

configure

protected void configure(Properties p)

This method can be overridden to customize the Spinner.
The following options are used by the Spinner:

interval The amount to increment (default=1)
round The number of decimal points to which to round (default=0)
min The lowest allowed value, false for no min (default=false)
max The highest allowed value, false for no max (default=false)
prefix String to prepend when updating (default='')
suffix String to append when updating (default='')
data An array giving a list of items through which to iterate
onIncrement Function to call after incrementing
onDecrement Function to call after decrementing
afterUpdate Function to call after update of the value
onStop Function to call on click or mouseup (default=false)

Parameters:: p -

getSpinDownComponent

protected Component getSpinDownComponent()

Returns:: the component the is used to spin down.

getSpinUpComponent

protected Component getSpinUpComponent()

Returns:: the component that is used to spin up.

afterRender

public void afterRender(Component component)

Overrides:: afterRender in class Behavior

renderHead

public void renderHead(Component c,
                       org.apache.wicket.markup.head.IHeaderResponse response)

Specified by:: renderHead in interface IComponentAwareHeaderContributor
Overrides:: renderHead in class Behavior