JScrollPane

JScrollPane is a container with two scrollbar controllin the viewport's beeing viewed area.

If you want to change the unit or block increment of the scrollbars in a scrollpane, you shoud controll it with viewport instead of scrollbar directly, because the scrollbar's increment will be set to same to viewport's always. I mean use JViewport.horizontalUnitIncrement instead of JScrollBar.unitIncrement

@see org.aswing.Viewportable @see org.aswing.JViewport @see org.aswing.JScrollBar @author paling

Class Fields

`static var SCROLLBAR_ALWAYS:Int`

scrollbar are always displayed.

`static var SCROLLBAR_AS_NEEDED:Int`

scrollbar are displayed only when needed.

`static var SCROLLBAR_NEVER:Int`

scrollbar are never displayed.

Instance Fields

Show inherited public instance fields

Hide inherited public instance fields

Inherited from Container

var layout:LayoutManager

function append(com:Component, ?constraints:Dynamic):Void

function appendAll(coms:Array<Dynamic>):Void

function doLayout():Void

function getComponent(index:Int):Component

function getComponentCount():Int

function getComponents():Array<Dynamic>

function getFocusTraversalPolicy():FocusTraversalPolicy

function getIndex(com:Component):Int

function getLayout():LayoutManager

function insert(i:Int, com:Component, ?constraints:Dynamic):Void

function insertAll(index:Int, coms:Array<Dynamic>):Void

function invalidate():Void

function isAncestorOf(c:Component):Bool

function reAppendChildren():Void

function remove(com:Component):Component

function removeAll():Void

function removeAt(i:Int):Component

function removeChild(child:DisplayObject):DisplayObject

function removeChildAt(index:Int):DisplayObject

function setFocusTraversalPolicy(ftp:FocusTraversalPolicy):Void

function setLayout(layout:LayoutManager):Void

function validate():Void

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 horizontalScrollBar:JScrollBar`

`var horizontalScrollBarPolicy:Int`

Values:

#SCROLLBAR_AS_NEEDED
#SCROLLBAR_NEVER
#SCROLLBAR_ALWAYS

`var verticalScrollBar:JScrollBar`

`var verticalScrollBarPolicy:Int`

Values:

#SCROLLBAR_AS_NEEDED
#SCROLLBAR_NEVER
#SCROLLBAR_ALWAYS

`var viewport:Viewportable`

The viewport

Most applications will find it more convenient to use #setView to add a viewport or a view to the scrollpane.

@see #view @see org.aswing.JList @see org.aswing.JTextArea @see org.aswing.JTable

`function new(?viewOrViewport:Dynamic = null, ?vsbPolicy:Int = 0, ?hsbPolicy:Int = 0): Void`

Create a JScrollPane, you can specified a Component to be view, then here will create a JViewport to manager the view's scroll, or a Viewportable to be the view, it mananger the scroll itself. If view is not instanceof either, no view will be viewed.

@throw TypeError when viewOrViewport is not component or viewportable. @see #SCROLLBARASNEEDED @see #SCROLLBARNEVER @see #SCROLLBARALWAYS @see #setViewportView() @see #setViewport() @see org.aswing.Viewportable @see org.aswing.JViewport @see org.aswing.JList @see org.aswing.JTextArea

viewOrViewport	the scroll content component or a Viewportable
vsbPolicy	`#SCROLLBAR_AS_NEEDED` or `#SCROLLBAR_NEVER` or `#SCROLLBAR_ALWAYS`, default `#SCROLLBAR_AS_NEEDED`
hsbPolicy	`#SCROLLBAR_AS_NEEDED` or `#SCROLLBAR_NEVER` or `#SCROLLBAR_ALWAYS`, default `#SCROLLBAR_AS_NEEDED`

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

Adds a scrollbar scrolled listener. @see org.aswing.event.ScrollPaneEvent#SCROLLBARSTATECHANGED

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

`function getViewportView(): Component`

Returns the view currently in the scrollpane's viewport if the viewport is a JViewport instance, otherwise, null will be returned.

`function getVisibleRect(): IntRectangle`

Returns the visible extent rectangle related the current scroll properties.

returns

the visible extent rectangle

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

Removes a state listener. @see org.aswing.event.ScrollPaneEvent#SCROLLBARSTATECHANGED

listener

the listener to be removed.

`function setView(viewOrViewport:Dynamic): Void`

Sets the view to viewed and scrolled by this scrollpane. if this view is not a Viewportable implementation, then here will create a JViewport to manager the view's scroll, else the Viewportable will be the viewport.
If view is not instanceof either, no view will be set.
If you want to make a component viewed by your way, you have two way:

1.Make your component a Viewportable implementation.
2.Make a your new Viewportable likes JViewport, recommend you extends the JViewport, then make your component to be the viewport's view like JViewport does.

@see Viewportable @throw TypeError when viewOrViewport is not component or viewportable.

viewOrViewport

a component or a Viewportable object.

`function setViewportView(view:Component): Void`

If currently viewport is a JViewport instance, set the view to it. If not, then creates a JViewport and then sets this view. Applications that don't provide the view directly to the JScrollPane constructor should use this method to specify the scrollable child that's going to be displayed in the scrollpane. For example:

JScrollPane scrollpane = new JScrollPane();
scrollpane.setViewportView(myBigComponentToScroll);

Applications should not add children directly to the scrollpane.

@see #setViewport() @see org.aswing.JViewport#setView()

view	the component to add to the viewport

class org.aswing.JScrollPane extends Container

Class Fields

static var SCROLLBAR_ALWAYS:Int

static var SCROLLBAR_AS_NEEDED:Int

static var SCROLLBAR_NEVER:Int

Instance Fields

var horizontalScrollBar:JScrollBar

var horizontalScrollBarPolicy:Int

var verticalScrollBar:JScrollBar

var verticalScrollBarPolicy:Int

var viewport:Viewportable

function new(?viewOrViewport:Dynamic = null, ?vsbPolicy:Int = 0, ?hsbPolicy:Int = 0): Void

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

function getViewportView(): Component

function getVisibleRect(): IntRectangle

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

function setView(viewOrViewport:Dynamic): Void

function setViewportView(view:Component): Void

`class org.aswing.JScrollPane extends Container`