View source

class BaseScrollBar

package feathers.controls.supportClasses

extends FeathersControl › MeasureSprite › ValidatingSprite

implements IScrollBar

extended by HScrollBar, VScrollBar

@:build(feathers.macros.StyleMacro.build())@:autoBuild(feathers.macros.StyleMacro.build())@:build(feathers.macros.StyleContextMacro.build())@:autoBuild(feathers.macros.StyleContextMacro.build())@:event(openfl.events.Event.CHANGE)@:event(feathers.events.ScrollEvent.SCROLL_START)@:event(feathers.events.ScrollEvent.SCROLL_COMPLETE)

Base class for scroll bar components.

Available since

1.0.0

.

See also:

Variables

@:style@:flash.propertyfixedThumbSize:Bool

Determines if the scroll bar's thumb will be resized based on the scrollable range between the minimum and maximum, or if it will always be rendered at its preferred size, even if the minimum and maximum values change.

In the following example, the thumb size is fixed:

scrollBar.fixedThumbSize = true;
Available since

1.0.0

.

@:value(true)liveDragging:Bool = true

Determines if the scroll bar dispatches the Event.CHANGE event every time that the thumb moves while dragging, or only after the user stops dragging.

In the following example, live dragging is disabled:

scrollBar.liveDragging = false;
Available since

1.0.0

.

@:flash.propertymaximum:Float

The scroll bar's value cannot be larger than the maximum.

In the following example, the maximum is set to 100.0:

scrollBar.minimum = 0.0;
scrollBar.maximum = 100.0;
scrollBar.step = 1.0;
scrollBar.value = 12.0;
Available since

1.0.0

.

See also:

@:flash.propertyminimum:Float

The scroll bar's value cannot be smaller than the minimum.

In the following example, the minimum is set to -100.0:

scrollBar.minimum = -100.0;
scrollBar.maximum = 100.0;
scrollBar.step = 1.0;
scrollBar.value = 50.0;
Available since

1.0.0

.

See also:

@:style@:flash.propertypaddingBottom:Float

The minimum space, in pixels, between the scroll bar's bottom edge and the scroll bar's thumb.

In the following example, the scroll bar's bottom padding is set to 20 pixels:

scrollBar.paddingBottom = 20.0;
Available since

1.0.0

.

See also:

@:style@:flash.propertypaddingLeft:Float

The minimum space, in pixels, between the scroll bar's left edge and the scroll bar's thumb.

In the following example, the scroll bar's left padding is set to 20 pixels:

scrollBar.paddingLeft = 20.0;
Available since

1.0.0

.

See also:

@:style@:flash.propertypaddingRight:Float

The minimum space, in pixels, between the scroll bar's right edge and the scroll bar's thumb.

In the following example, the scroll bar's right padding is set to 20 pixels:

scrollBar.paddingRight = 20.0;
Available since

1.0.0

.

See also:

@:style@:flash.propertypaddingTop:Float

The minimum space, in pixels, between the scroll bar's top edge and the scroll bar's thumb.

In the following example, the scroll bar's top padding is set to 20 pixels:

scrollBar.paddingTop = 20.0;
Available since

1.0.0

.

See also:

@:flash.propertypage:Float

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

If page is 0.0, the value of step will be used instead. If step is also 0.0, then paging will be disabled.

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

scrollBar.minimum = 0.0;
scrollBar.maximum = 100.0;
scrollBar.step = 1.0;
scrollBar.page = 10.0;
scrollBar.value = 10.0;
Available since

1.0.0

.

See also:

@:style@:flash.propertysecondaryTrackSkin:InteractiveObject

The skin to use for the scroll bar's optional secondary track. If a scroll bar has one track, it will fill the entire length of the scroll bar. If a scroll bar has a track and a secondary track, the primary track will stretch between the minimum edge of the scroll bar and the location of the scroll bar's thumb, while the secondary track will stretch from the location of the scroll bar's thumb to the maximum edge of the scroll bar.

In the following example, a track skin and a secondary track skin are passed to the scroll bar:

var skin = new RectangleSkin();
skin.fill = SolidColor(0xaaaaaa);
scrollBar.trackSkin = skin;

var skin = new RectangleSkin();
skin.fill = SolidColor(0xcccccc);
scrollBar.secondaryTrackSkin = skin;
Available since

1.0.0

.

See also:

@:flash.propertysnapInterval:Float

When the scroll bar's value changes, it may be "snapped" to the nearest multiple of snapInterval. If snapInterval is 0.0, the value is not snapped.

In the following example, the snap inverval is changed to 1.0:

slider.minimum = 0.0;
slider.maximum = 100.0;
slider.step = 1.0;
slider.snapInterval = 1.0;
slider.value = 10.0;
Available since

1.0.0

.

See also:

@:flash.propertystep:Float

When the scroll bar's increment/decrement buttons are triggered, the value is modified by adding or subtracting step.

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

scrollBar.minimum = 0.0;
scrollBar.maximum = 100.0;
scrollBar.step = 1.0;
scrollBar.value = 10.0;
Available since

1.0.0

.

See also:

@:style@:flash.propertythumbSkin:InteractiveObject

The skin to use for the scroll bar's thumb.

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

var skin = new RectangleSkin();
skin.fill = SolidColor(0xcccccc);
scrollBar.thumbSkin = skin;
Available since

1.0.0

.

See also:

@:style@:flash.propertytrackSkin:InteractiveObject

The skin to use for the scroll bar's track.

In the following example, a track skin is passed to the scroll bar:

var skin = new RectangleSkin();
skin.fill = SolidColor(0xcccccc);
scrollBar.trackSkin = skin;
Available since

1.0.0

.

See also:

@:flash.propertyvalue:Float

The value of the scroll bar, which must be between the minimum and the maximum.

When the value property changes, the scroll bar will dispatch an event of type Event.CHANGE.

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

scrollBar.minimum = 0.0;
scrollBar.maximum = 100.0;
scrollBar.step = 1.0;
scrollBar.value = 12.0;
Available since

1.0.0

.

See also:

Inherited Variables

Defined by FeathersControl

@:flash.propertyread onlycreated:Bool

Determines if the component has been initialized and validated for the first time.

In the following example, we check if the component is created or not, and we listen for an event if it isn't:

if(!control.created)
{
	control.addEventListener(FeathersEventType.CREATION_COMPLETE, creationCompleteHandler);
}

See also:

@:flash.propertyenabled:Bool

See also:

@:flash.propertyfocusEnabled:Bool

See also:

@:flash.propertyfocusManager:IFocusManager

See also:

@style@:flash.propertyfocusPaddingBottom:Float

Optional padding outside the bottom edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@style@:flash.propertyfocusPaddingLeft:Float

Optional padding outside the left edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@style@:flash.propertyfocusPaddingRight:Float

Optional padding outside the right edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@style@:flash.propertyfocusPaddingTop:Float

Optional padding outside the top edge of this UI component when the focusRectSkin is visible.

Available since

1.0.0

.

@style@:flash.propertyfocusRectSkin:DisplayObject

An optional skin to display when an IFocusObject component receives focus.

Available since

1.0.0

.

@:flash.propertyincludeInLayout:Bool

See also:

@:flash.propertyread onlyinitialized:Bool

Determines if the component has been initialized yet. The initialize() function is called one time only, when the Feathers UI control is added to the display list for the first time.

In the following example, we check if the component is initialized or not, and we listen for an event if it isn't initialized:

if(!control.initialized)
{
	control.addEventListener(FeathersEvent.INITIALIZE, initializeHandler);
}
Available since

1.0.0

.

See also:

@style@:flash.propertylayoutData:ILayoutData

See also:

@:flash.propertyread onlystyleContext:Class<IStyleObject>

The class used as the context for styling the component. If a subclass of a component should have different styles than its superclass, it should override the get_styleContext getter. However, if a subclass should continue using the same styles as its superclass, it happens automatically.

Available since

1.0.0

.

@:flash.propertystyleProvider:IStyleProvider

When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.

You can set or replace an existing style provider at any time before a component initializes without immediately affecting the component's visual appearance. After the component initializes, the style provider may still be changed, and any properties that were set by the previous style provider will be reset to their default values before applying the new style provider.

Available since

1.0.0

.

See also:

@:flash.propertythemeEnabled:Bool

See also:

@:flash.propertyvariant:String

May be used to provide multiple different variations of the same UI component, each with a different appearance.

Available since

1.0.0

.

Defined by MeasureSprite

@:flash.propertyexplicitHeight:Null<Float>

See also:

@:flash.propertyexplicitMaxHeight:Null<Float>

See also:

@:flash.propertyexplicitMaxWidth:Null<Float>

See also:

@:flash.propertyexplicitMinHeight:Null<Float>

See also:

@:flash.propertyexplicitMinWidth:Null<Float>

See also:

@:flash.propertyexplicitWidth:Null<Float>

See also:

@:flash.propertymaxHeight:Float

See also:

@:flash.propertymaxWidth:Float

See also:

@:flash.propertyminHeight:Float

See also:

@:flash.propertyminWidth:Float

See also:

Defined by ValidatingSprite

@:flash.propertyread onlydepth:Int

See also:

Inherited Methods

Defined by FeathersControl

private@:dox(show)initialize():Void

Called the first time that the UI control is added to the stage, and you should override this function to customize the initialization process. Do things like create children and set up event listeners. After this function is called, Event.INIT is dispatched.

The following example overrides initialization:

override private function initialize():Void {
	super.initialize();

}
Available since

1.0.0

.

initializeNow():Void

See also:

move(x:Float, y:Float):Void

Sets both the x and y positions of the control in a single function call.

Available since

1.0.0

.

See also:

  • DisplayObject.x

  • DisplayObject.y

setSize(width:Float, height:Float):Void

Sets both the width and height dimensions of the control in a single function call.

Available since

1.0.0

.

See also:

  • DisplayObject.width

  • DisplayObject.height

private@:dox(show)setStyle(styleName:String, ?state:EnumValue):Bool

Determines if a style may be changed, and restricts the style from being changed in the future, if necessary.

Available since

1.0.0

.

showFocus(show:Bool):Void

See also:

Defined by MeasureSprite

resetHeight():Void

See also:

resetMaxHeight():Void

See also:

resetMaxWidth():Void

See also:

resetMinHeight():Void

See also:

resetMinWidth():Void

See also:

resetWidth():Void

See also:

private@:value({ minHeight : 0.0, minWidth : 0.0 })@:dox(show)saveMeasurements(width:Float, height:Float, minWidth:Float = 0.0, minHeight:Float = 0.0, ?maxWidth:Float, ?maxHeight:Float):Bool

Saves the calculated dimensions for the component, replacing any values that haven't been set explicitly. Returns true if the reported values have changed and Event.RESIZE was dispatched.

Available since

1.0.0

.

Defined by ValidatingSprite

isInvalid(?flag:InvalidationFlag):Bool

Indicates whether the control is pending validation or not. By default, returns true if any invalidation flag has been set. If you pass in a specific flag, returns true only if that flag has been set (others may be set too, but it checks the specific flag only. If all flags have been marked as invalid, always returns true.

The following example invalidates a component:

component.setInvalid();
trace(component.isInvalid()); // true
Available since

1.0.0

.

runWithoutInvalidation(callback:() ‑> Void):Void

Calls a function that temporarily disables invalidation. In other words, calls to setInvalid() will be ignored until the function returns.

Available since

1.0.0

.

setInvalid(?flag:InvalidationFlag):Void

Call this function to tell the UI control that a redraw is pending. The redraw will happen immediately before OpenFL renders the UI control to the screen. The validation system exists to ensure that multiple properties can be set together without redrawing multiple times in between each property change.

If you cannot wait until later for the validation to happen, you can call validate() to redraw immediately. As an example, you might want to validate immediately if you need to access the correct width or height values of the UI control, since these values are calculated during validation.

The following example invalidates a component:

component.setInvalid();
trace(component.isInvalid()); // true
Available since

1.0.0

.

private@:dox(show)setInvalidationFlag(flag:InvalidationFlag):Void

Sets an invalidation flag. This will not add the component to the validation queue. It only sets the flag. A subclass might use this function during draw() to manipulate the flags that its superclass sees.

Available since

1.0.0

.

See also:

private@:dox(show)update():Void

Override to customize layout and to adjust properties of children. Called when the component validates, if any flags have been marked to indicate that validation is pending.

The following example overrides updating after invalidation:

override private function update():Void {
	super.update();

}
Available since

1.0.0

.