The scroll bar's decrement button sub-component.

For internal use in subclasses.

See also

A function used to generate the scroll bar's decrement button sub-component. The decrement button must be an instance of BasicButton. This factory can be used to change properties on the decrement button when it is first created. For instance, if you are skinning Feathers components without a theme, you might use this factory to set skins and other styles on the decrement button.

The function should have the following signature:

function():BasicButton

In the following example, a custom decrement button factory is passed to the scroll bar:

scrollBar.decrementButtonFactory = function():BasicButton
{
    var button:BasicButton = new BasicButton();
    button.defaultSkin = new Image( upTexture );
    button.downSkin = new Image( downTexture );
    return button;
};

The default value is null.

See also

An object that stores properties for the scroll bar's decrement button, and the properties will be passed down to the decrement button when the scroll bar validates. For a list of available properties, refer to feathers.controls.BasicButton.

If the subcomponent has its own subcomponents, their properties can be set too, using attribute @ notation. For example, to set the skin on the thumb which is in a SimpleScrollBar, which is in a List, you can use the following syntax:

list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);

Setting properties in a decrementButtonFactory function instead of using decrementButtonProperties will result in better performance.

In the following example, the scroll bar's decrement button properties are updated:

scrollBar.decrementButtonProperties.defaultSkin = new Image( upTexture );
scrollBar.decrementButtonProperties.downSkin = new Image( downTexture );

The default value is null.

See also

The value added to the styleNameList of the decrement button. This variable is protected so that sub-classes can customize the decrement button style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_DECREMENT_BUTTON.

To customize the decrement button style name without subclassing, see customDecrementButtonStyleName.

See also

The default IStyleProvider for all ScrollBar components.

The default value is null.

See also

The scroll bar's increment button sub-component.

For internal use in subclasses.

See also

A function used to generate the scroll bar's increment button sub-component. The increment button must be an instance of BasicButton. This factory can be used to change properties on the increment button when it is first created. For instance, if you are skinning Feathers components without a theme, you might use this factory to set skins and other styles on the increment button.

The function should have the following signature:

function():BasicButton

In the following example, a custom increment button factory is passed to the scroll bar:

scrollBar.incrementButtonFactory = function():BasicButton
{
    var button:BasicButton = new BasicButton();
    button.defaultSkin = new Image( upTexture );
    button.downSkin = new Image( downTexture );
    return button;
};

The default value is null.

See also

An object that stores properties for the scroll bar's increment button, and the properties will be passed down to the increment button when the scroll bar validates. For a list of available properties, refer to feathers.controls.BasicButton.

If the subcomponent has its own subcomponents, their properties can be set too, using attribute @ notation. For example, to set the skin on the thumb which is in a SimpleScrollBar, which is in a List, you can use the following syntax:

list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);

Setting properties in a incrementButtonFactory function instead of using incrementButtonProperties will result in better performance.

In the following example, the scroll bar's increment button properties are updated:

scrollBar.incrementButtonProperties.defaultSkin = new Image( upTexture );
scrollBar.incrementButtonProperties.downSkin = new Image( downTexture );

The default value is null.

See also

The value added to the styleNameList of the increment button. This variable is protected so that sub-classes can customize the increment button style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_INCREMENT_BUTTON.

To customize the increment button style name without subclassing, see customIncrementButtonName.

See also

Determines if the scroll bar dispatches the Event.CHANGE event every time the thumb moves, or only once it stops moving.

In the following example, live dragging is disabled:

scrollBar.liveDragging = false;

The default value is true.

The maximum numeric value of the range.

In the following example, the maximum is changed to 100:

component.minimum = 0;
component.maximum = 100;
component.step = 1;
component.page = 10
component.value = 12;

The default value is 0.

See also

The scroll bar's maximum track sub-component.

For internal use in subclasses.

See also

A function used to generate the scroll bar's maximum track sub-component. The maximum track must be an instance of BasicButton. This factory can be used to change properties on the maximum track when it is first created. For instance, if you are skinning Feathers components without a theme, you might use this factory to set skins and other styles on the maximum track.

The function should have the following signature:

function():BasicButton

In the following example, a custom maximum track factory is passed to the scroll bar:

scrollBar.maximumTrackFactory = function():BasicButton
{
    var track:BasicButton = new BasicButton();
    track.defaultSkin = new Image( upTexture );
    track.downSkin = new Image( downTexture );
    return track;
};

The default value is null.

See also

An object that stores properties for the scroll bar's "maximum" track, and the properties will be passed down to the "maximum" track when the scroll bar validates. For a list of available properties, refer to feathers.controls.BasicButton.

If the subcomponent has its own subcomponents, their properties can be set too, using attribute @ notation. For example, to set the skin on the thumb which is in a SimpleScrollBar, which is in a List, you can use the following syntax:

list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);

Setting properties in a maximumTrackFactory function instead of using maximumTrackProperties will result in better performance.

In the following example, the scroll bar's maximum track properties are updated:

scrollBar.maximumTrackProperties.defaultSkin = new Image( upTexture );
scrollBar.maximumTrackProperties.downSkin = new Image( downTexture );

The default value is null.

See also

The value added to the styleNameList of the maximum track. This variable is protected so that sub-classes can customize the maximum track style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_MAXIMUM_TRACK.

To customize the maximum track style name without subclassing, see customMaximumTrackStyleName.

See also

The minimum numeric value of the range.

In the following example, the minimum is changed to 0:

component.minimum = 0;
component.maximum = 100;
component.step = 1;
component.page = 10
component.value = 12;

The default value is 0.

See also

The scroll bar's minimum track sub-component.

For internal use in subclasses.

See also

A function used to generate the scroll bar's minimum track sub-component. The minimum track must be an instance of BasicButton. This factory can be used to change properties on the minimum track when it is first created. For instance, if you are skinning Feathers components without a theme, you might use this factory to set skins and other styles on the minimum track.

The function should have the following signature:

function():BasicButton

In the following example, a custom minimum track factory is passed to the scroll bar:

scrollBar.minimumTrackFactory = function():BasicButton
{
    var track:BasicButton = new BasicButton();
    track.defaultSkin = new Image( upTexture );
    track.downSkin = new Image( downTexture );
    return track;
};

The default value is null.

See also

An object that stores properties for the scroll bar's "minimum" track, and the properties will be passed down to the "minimum" track when the scroll bar validates. For a list of available properties, refer to feathers.controls.BasicButton.

If the subcomponent has its own subcomponents, their properties can be set too, using attribute @ notation. For example, to set the skin on the thumb which is in a SimpleScrollBar, which is in a List, you can use the following syntax:

list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);

Setting properties in a minimumTrackFactory function instead of using minimumTrackProperties will result in better performance.

In the following example, the scroll bar's minimum track properties are updated:

scrollBar.minimumTrackProperties.defaultSkin = new Image( upTexture );
scrollBar.minimumTrackProperties.downSkin = new Image( downTexture );

The default value is null.

See also

The value added to the styleNameList of the minimum track. This variable is protected so that sub-classes can customize the minimum track style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_MINIMUM_TRACK.

To customize the minimum track style name without subclassing, see customMinimumTrackStyleName.

See also

The amount the scroll bar value must change to get from one "page" to the next.

If this value is 0, the step value will be used instead. If the step value is 0, paging is not possible.

In the following example, the page is changed to 10:

scrollBar.minimum = 0;
scrollBar.maximum = 100;
scrollBar.step = 1;
scrollBar.page = 10
scrollBar.value = 12;

The default value is 0.

See also

The time, in seconds, before actions are repeated. The first repeat happens after a delay that is five times longer than the following repeats.

In the following example, the repeat delay is changed to 500 milliseconds:

scrollBar.repeatDelay = 0.5;

The default value is 0.05.

The amount the value must change to increment or decrement.

In the following example, the step is changed to 1:

component.minimum = 0;
component.maximum = 100;
component.step = 1;
component.page = 10
component.value = 12;

The default value is 0.

See also

The scroll bar's thumb sub-component.

For internal use in subclasses.

See also

A function used to generate the scroll bar's thumb sub-component. The thumb must be an instance of Button. This factory can be used to change properties on the thumb when it is first created. For instance, if you are skinning Feathers components without a theme, you might use this factory to set skins and other styles on the thumb.

The function should have the following signature:

function():BasicButton

In the following example, a custom thumb factory is passed to the scroll bar:

scrollBar.thumbFactory = function():BasicButton
{
    var thumb:BasicButton = new BasicButton();
    thumb.defaultSkin = new Image( upTexture );
    thumb.downSkin = new Image( downTexture );
    return thumb;
};

The default value is null.

See also

An object that stores properties for the scroll bar's thumb, and the properties will be passed down to the thumb when the scroll bar validates. For a list of available properties, refer to feathers.controls.BasicButton.

If the subcomponent has its own subcomponents, their properties can be set too, using attribute @ notation. For example, to set the skin on the thumb which is in a SimpleScrollBar, which is in a List, you can use the following syntax:

list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);

Setting properties in a thumbFactory function instead of using thumbProperties will result in better performance.

In the following example, the scroll bar's thumb properties are updated:

scrollBar.thumbProperties.defaultSkin = new Image( upTexture );
scrollBar.thumbProperties.downSkin = new Image( downTexture );

The default value is null.

See also

The value added to the styleNameList of the thumb. This variable is protected so that sub-classes can customize the thumb style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_THUMB.

To customize the thumb style name without subclassing, see customThumbStyleName.

See also

The current numeric value.

In the following example, the value is changed to 12:

component.minimum = 0;
component.maximum = 100;
component.step = 1;
component.page = 10
component.value = 12;

The default value is 0.

See also

Constructor.

If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself. If the explicitWidth or explicitHeight member variables are set, those value will be used without additional measurement. If one is set, but not the other, the dimension with the explicit value will not be measured, but the other non-explicit dimension will still need measurement.

Calls saveMeasurements() to set up the actualWidth and actualHeight member variables used for layout.

Meant for internal use, and subclasses may override this function with a custom implementation.

Creates and adds the decrementButton sub-component and removes the old instance, if one exists.

Meant for internal use, and subclasses may override this function with a custom implementation.

See also

Creates and adds the incrementButton sub-component and removes the old instance, if one exists.

Meant for internal use, and subclasses may override this function with a custom implementation.

See also

Creates and adds the maximumTrack sub-component and removes the old instance, if one exists. If the maximum track is not needed, it will not be created.

Meant for internal use, and subclasses may override this function with a custom implementation.

See also

Creates and adds the minimumTrack sub-component and removes the old instance, if one exists.

Meant for internal use, and subclasses may override this function with a custom implementation.

See also

Creates and adds the thumb sub-component and removes the old instance, if one exists.

Meant for internal use, and subclasses may override this function with a custom implementation.

See also

Dispatched when the user starts interacting with the scroll bar's thumb, track, or buttons.

The properties of the event object have the following values:

Dispatched when the scroll bar's value changes.

The properties of the event object have the following values:

Dispatched when the user stops interacting with the scroll bar's thumb, track, or buttons.

The properties of the event object have the following values:

Depending on the control, the result of the interaction may continue after the interaction ends. For instance, a Scroller may be "thrown", and the scrolling will continue animating after the user has finished interacting with it.

Determines how the minimum and maximum track skins are positioned and sized.

In the following example, the scroll bar is given two tracks:

scrollBar.trackLayoutMode = TrackLayoutMode.SPLIT;

The default value is feathers.controls.TrackLayoutMode.SINGLE.

See also

The minimum space, in pixels, to the left of the content, not including the track(s).

In the following example, the left padding is changed to 20 pixels:

scrollBar.paddingLeft = 20;

The default value is 0.

See also

The minimum space, in pixels, below the content, not including the track(s).

In the following example, the bottom padding is changed to 20 pixels:

scrollBar.paddingBottom = 20;

The default value is 0.

See also

The minimum space, in pixels, to the right of the content, not including the track(s).

In the following example, the right padding is changed to 20 pixels:

scrollBar.paddingRight = 20;

The default value is 0.

See also

The minimum space, in pixels, above the content, not including the track(s).

In the following example, the top padding is changed to 20 pixels:

scrollBar.paddingTop = 20;

The default value is 0.

See also

Quickly sets all padding properties to the same value. The padding getter always returns the value of paddingTop, but the other padding values may be different.

In the following example, the padding is changed to 20 pixels:

scrollBar.padding = 20;

The default value is 0.

See also

Determines if the scroll bar's thumb will be resized based on the scrollable range, or if it will be rendered at its preferred size.

In the following example, the thumb size is fixed:

scrollBar.fixedThumbSize = true;

The default value is false.

Determines if the scroll bar's thumb can be dragged horizontally or vertically. When this value changes, the scroll bar's width and height values do not change automatically.

Note: When using a ScrollBar with a scrolling container, the container will automatically set the correct direction value. Generally, you should not need to set this style manually.

In the following example, the direction is changed to vertical:

scrollBar.direction = Direction.VERTICAL;

Note: The Direction.NONE constant is not supported.

The default value is feathers.layout.Direction.HORIZONTAL.

See also

A style name to add to the scroll bar's thumb sub-component. Typically used by a theme to provide different styles to different scroll bars.

In the following example, a custom thumb style name is passed to the scroll bar:

scrollBar.customThumbStyleName = "my-custom-thumb";

In your theme, you can target this sub-component style name to provide different styles than the default:

getStyleProviderForClass( Button ).setFunctionForStyleName( "my-custom-thumb", setCustomThumbStyles );

The default value is null.

See also

A style name to add to the scroll bar's maximum track sub-component. Typically used by a theme to provide different styles to different scroll bars.

In the following example, a custom maximum track style name is passed to the scroll bar:

scrollBar.customMaximumTrackStyleName = "my-custom-maximum-track";

In your theme, you can target this sub-component style name to provide different styles than the default:

getStyleProviderForClass( Button ).setFunctionForStyleName( "my-custom-maximum-track", setCustomMaximumTrackStyles );

The default value is null.

See also

A style name to add to the scroll bar's minimum track sub-component. Typically used by a theme to provide different styles to different scroll bars.

In the following example, a custom minimum track style name is passed to the scroll bar:

scrollBar.customMinimumTrackStyleName = "my-custom-minimum-track";

In your theme, you can target this sub-component style name to provide different styles than the default:

getStyleProviderForClass( Button ).setFunctionForStyleName( "my-custom-minimum-track", setCustomMinimumTrackStyles );

The default value is null.

See also

A style name to add to the scroll bar's increment button sub-component. Typically used by a theme to provide different styles to different scroll bars.

In the following example, a custom increment button style name is passed to the scroll bar:

scrollBar.customIncrementButtonStyleName = "my-custom-increment-button";

In your theme, you can target this sub-component style name to provide different styles than the default:

getStyleProviderForClass( Button ).setFunctionForStyleName( "my-custom-increment-button", setCustomIncrementButtonStyles );

The default value is null.

See also

A style name to add to the scroll bar's decrement button sub-component. Typically used by a theme to provide different styles to different scroll bars.

In the following example, a custom decrement button style name is passed to the scroll bar:

scrollBar.customDecrementButtonStyleName = "my-custom-decrement-button";

In your theme, you can target this sub-component style name to provide different skins than the default style:

getStyleProviderForClass( Button ).setFunctionForStyleName( "my-custom-decrement-button", setCustomDecrementButtonStyles );

The default value is null.

See also

The default value added to the styleNameList of the decrement button.

See also

The default value added to the styleNameList of the increment button.

See also

The default value added to the styleNameList of the maximum track.

See also

The default value added to the styleNameList of the minimum track.

See also

The default value added to the styleNameList of the thumb.

See also