JScrollBar

An implementation of a scrollbar.

The user positions the knob in the scrollbar to determine the contents of the viewing area. The program typically adjusts the display so that the end of the scrollbar represents the end of the displayable contents, or 100% of the contents. The start of the scrollbar is the beginning of the displayable contents, or 0%. The position of the knob within those bounds then translates to the corresponding percentage of the displayable contents. * Typically, as the position of the knob in the scrollbar changes a corresponding change is made to the position of the JViewport on the underlying view, changing the contents of the JViewport. @author paling

Class Fields

`static var HORIZONTAL:Int`

Horizontal orientation.

`static var VERTICAL:Int`

Vertical orientation.

Instance Fields

Show inherited public instance fields

Hide inherited public instance fields

Inherited from Component

var __fieldBindings__:FieldsBindSignal

var __methodBindings__:MethodsBindSignal

var alignmentX:Float

var alignmentY:Float

var background:ASColor

var backgroundDecorator:GroundDecorator

var border:Border

var bounds:IntRectangle

var clipBounds:IntRectangle

var constraints:Dynamic

var currentSize:IntDimension

var dragEnabled:Bool

var dropTrigger:Bool

var enabled:Bool

var focusable:Bool

var focusableSet:Bool

var font:ASFont

var foreground:ASColor

var foregroundDecorator:GroundDecorator

var location:IntPoint

var maximumSize:IntDimension

var mideground:ASColor

var minimumSize:IntDimension

var opaque:Bool

var opaqueSet:Bool

var preferredSize:IntDimension

var resizerMargin:Insets

var styleProxy:Component

var styleTune:StyleTune

var toolTipText:String

var transitFocusFactor:Float

var ui:ComponentUI

var uiElement:Bool

var visibility:Bool

function addDragAcceptableInitiator(com:Component):Void

function componentToGlobal(p:IntPoint):IntPoint

function getClientProperty(key:String, ?defaultValue:Dynamic):Dynamic

function getDefaultBasicUIClass():Class<Dynamic>

function getFocusManager():FocusManager

function getGlobalLocation(?rv:IntPoint):IntPoint

function getInsets():Insets

function getInternalFocusObject():InteractiveObject

function getKeyboardManager():KeyboardManager

function getMousePosition():IntPoint

function getPaintBounds():IntRectangle

function getParent():Container

function getRootPaneAncestor():JRootPane

function getUIClassID():String

function globalToComponent(p:IntPoint):IntPoint

function hitTestMouse():Bool

function invalidate():Void

function invalidatePreferSizeCaches():Void

function isCachePreferSizes():Bool

function isDragAcceptableInitiator(com:Component):Bool

function isFocusOwner():Bool

function isFontValidated():Bool

function isOnStage():Bool

function isShowing():Bool

function isValid():Bool

function isValidateRoot():Bool

function makeFocus():Void

function pack():Void

function paintFocusRect(?force:Bool):Void

function paintImmediately():Void

function parentReAppendChildren():Void

function putClientProperty(key:String, value:Dynamic):Void

function reAppendToParent(?constraints:Dynamic):Void

function removeDragAcceptableInitiator(com:Component):Void

function removeFromContainer():Void

function repaint():Void

function repaintAndRevalidate():Void

function requestFocus():Bool

function revalidate():Void

function setCachePreferSizes(b:Bool):Void

function setClipSize(size:IntDimension):Void

function setDragAcceptableInitiatorAppraiser(func:Dynamic ->Bool):Void

function setFontValidated(b:Bool):Void

function setGlobalLocation(gp:IntPoint):Void

function transferFocus():Bool

function transferFocusBackward():Bool

function updateUI():Void

function validate():Void

Inherited from AWSprite

function bringToBottom(child:DisplayObject):Void

function bringToTop(child:DisplayObject):Void

function containsChild(child:DisplayObject):Bool

function getHighestIndexUnderForeground():Int

function getLowestIndexAboveBackground():Int

function isClipMasked():Bool

function setChildIndex(child:DisplayObject, index:Int):Void

function setClipMaskRect(b:IntRectangle):Void

function setClipMasked(m:Bool):Void

function toString():String

Inherited from Sprite

var buttonMode:Bool

var dropTarget:DisplayObject

var graphics:Graphics

var hitArea:Sprite

var soundTransform:SoundTransform

var useHandCursor:Bool

function startDrag(?lockCenter:Bool, ?bounds:Rectangle):Void

function startTouchDrag(touchPointID:Int, ?lockCenter:Bool, ?bounds:Rectangle):Void

function stopDrag():Void

function stopTouchDrag(touchPointID:Int):Void

Inherited from DisplayObjectContainer

var mouseChildren:Bool

var numChildren:Int

var tabChildren:Bool

var textSnapshot:TextSnapshot

function addChild(child:DisplayObject):DisplayObject

function addChildAt(child:DisplayObject, index:Int):DisplayObject

function areInaccessibleObjectsUnderPoint(point:Point):Bool

function contains(child:DisplayObject):Bool

function getChildAt(index:Int):DisplayObject

function getChildByName(name:String):DisplayObject

function getChildIndex(child:DisplayObject):Int

function getObjectsUnderPoint(point:Point):Array<DisplayObject>

function removeChild(child:DisplayObject):DisplayObject

function removeChildAt(index:Int):DisplayObject

function setChildIndex(child:DisplayObject, index:Int):Void

function swapChildren(child1:DisplayObject, child2:DisplayObject):Void

function swapChildrenAt(index1:Int, index2:Int):Void

Inherited from InteractiveObject

var accessibilityImplementation:AccessibilityImplementation

var contextMenu:ContextMenu

var doubleClickEnabled:Bool

var focusRect:Dynamic

var mouseEnabled:Bool

var tabEnabled:Bool

var tabIndex:Int

Inherited from DisplayObject

var accessibilityProperties:AccessibilityProperties

var alpha:Float

var blendMode:BlendMode

var blendShader:Shader

var cacheAsBitmap:Bool

var filters:Array<BitmapFilter>

var height:Float

var loaderInfo:LoaderInfo

var mask:DisplayObject

var mouseX:Float

var mouseY:Float

var name:String

var opaqueBackground:Null<UInt>

var parent:DisplayObjectContainer

var root:DisplayObject

var rotation:Float

var rotationX:Float

var rotationY:Float

var rotationZ:Float

var scale9Grid:Rectangle

var scaleX:Float

var scaleY:Float

var scaleZ:Float

var scrollRect:Rectangle

var stage:Stage

var transform:Transform

var visible:Bool

var width:Float

var x:Float

var y:Float

var z:Float

function getBounds(targetCoordinateSpace:DisplayObject):Rectangle

function getRect(targetCoordinateSpace:DisplayObject):Rectangle

function globalToLocal(point:Point):Point

function globalToLocal3D(point:Point):Vector3D

function hitTestObject(obj:DisplayObject):Bool

function hitTestPoint(x:Float, y:Float, ?shapeFlag:Bool):Bool

function local3DToGlobal(point3d:Vector3D):Point

function localToGlobal(point:Point):Point

Inherited from EventDispatcher

function addEventListener(type:String, listener:Dynamic ->Void?useCapture:Bool, ?priority:Int, ?useWeakReference:Bool):Void

function dispatchEvent(event:Event):Bool

function hasEventListener(type:String):Bool

function removeEventListener(type:String, listener:Dynamic ->Void?useCapture:Bool):Void

function toString():String

function willTrigger(type:String):Bool

`var blockIncrement:Int`

The amount to change the scrollbar's value by, given a block (usually "page") up/down request.

A ScrollBarUI implementation typically calls this method when the user clicks above or below the scrollbar "knob" to change the value up or down by large amount. Subclasses my override this method to compute a value, e.g. the change required to scroll up or down one paragraph in a text document.

The JScrollPane component creates scrollbars (by default) that then set the block increment by the viewport, if it has one. The Viewportable interface provides a method to return the block increment.

@see JScrollPane @see Viewportable

`var extent:Int`

Sets the size of the range "covered" by the knob. Most look and feel implementations will change the value by this amount if the user clicks on either side of the knob.

@see BoundedRangeModel#setExtent()

`var maximum:Int`

The model's maximum property. @see BoundedRangeModel#setMaximum()

`var minimum:Int`

The model's minimum property. @see BoundedRangeModel#setMinimum()

`var model:BoundedRangeModel`

The model that handles the scrollbar's four fundamental properties: minimum, maximum, value, extent.

`var orientation:Int`

`var unitIncrement:Int`

The amount to change the scrollbar's value by, given a unit up/down request.

A ScrollBarUI implementation typically calls this method when the user clicks on a scrollbar up/down arrow and uses the result to update the scrollbar's value. Subclasses may override this method to compute a value, e.g. the change required to scroll up or down one (variable height) line text or one row in a table.

The JScrollPane component creates scrollbars (by default) that then set the unit increment by the viewport, if it has one. The Viewportable interface provides a method to return the unit increment.

@see org.aswing.JScrollPane @see org.aswing.Viewportable

`var value:Int`

The scrollbar's value. This method just forwards the value to the model. @see BoundedRangeModel#setValue()

`function new(?orientation:Int = 1, ?value:Int = 0, ?extent:Int = 10, ?min:Int = 0, ?max:Int = 100): Void`

JScrollBar(orientation:Number, value:Number, extent:Number, min:Number, max:Number)
JScrollBar(orientation:Number) default to value=0, extent=10, min=0, max=100

Creates a scrollbar with the specified orientation, value, extent, minimum, and maximum. The "extent" is the size of the viewable area. It is also known as the "visible amount".

Note: Use setBlockIncrement to set the block increment to a size slightly smaller than the view's extent. That way, when the user jumps the knob to an adjacent position, one or two lines of the original contents remain in view.

orientation	the scrollbar's orientation to either `this.VERTICAL` or `this.HORIZONTAL`.
value
extent
min
null	max

`function addStateListener(listener:Dynamic ->Void?priority:Int = 0, ?useWeakReference:Bool = false): Void`

Adds a listener to listen the scrollBar's state change event. @see org.aswing.event.InteractiveEvent#STATE_CHANGED

listener	the listener
priority	the priority
useWeakReference	Determines whether the reference to the listener is strong or weak.

`function removeStateListener(listener:Dynamic ->Void): Void`

Removes a state listener. @see org.aswing.event.InteractiveEvent#STATE_CHANGED

listener

the listener to be removed.

`function setValues(newValue:Int, newExtent:Int, newMin:Int, newMax:Int, ?programmatic:Bool = true): Void`

Sets the four BoundedRangeModel properties after forcing the arguments to obey the usual constraints: "minimum le value le value+extent le maximum" ("le" means less or equals)

class org.aswing.JScrollBar extends Component

Class Fields

static var HORIZONTAL:Int

static var VERTICAL:Int

Instance Fields

var blockIncrement:Int

var extent:Int

var maximum:Int

var minimum:Int

var model:BoundedRangeModel

var orientation:Int

var unitIncrement:Int

var value:Int

function new(?orientation:Int = 1, ?value:Int = 0, ?extent:Int = 10, ?min:Int = 0, ?max:Int = 100): Void

function addStateListener(listener:Dynamic ->Void?priority:Int = 0, ?useWeakReference:Bool = false): Void

function removeStateListener(listener:Dynamic ->Void): Void

function setValues(newValue:Int, newExtent:Int, newMin:Int, newMax:Int, ?programmatic:Bool = true): Void

`class org.aswing.JScrollBar extends Component`