JViewport

JViewport is an basic viewport to view normal components. Generally JViewport works with JScrollPane together, for example:

    var scrollPane:JScrollPane = new JScrollPane();
    var viewport:JViewport = new JViewport(yourScrollContentComponent, true, false);
    scrollPane.setViewport(viewport);

Then you'll get a scrollpane with scroll content and only vertical scrollbar. And the scroll content will always tracks the scroll pane width.

Authors: paling, ngrebenshikov

Class Fields

`static var AUTO_INCREMENT:Int`

The default unit/block increment, it means auto count a value.

`static var BOTTOM:Int`

A fast access to `AsWingConstants Constant

`static var CENTER:Int`

A fast access to AsWingConstants Constant

`static var LEFT:Int`

A fast access to AsWingConstants Constant

`static var RIGHT:Int`

A fast access to AsWingConstants Constant

`static var TOP:Int`

A fast access to AsWingConstants Constant

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 fitViewHeight:Bool`

If true, the view will always be set to the same height as the viewport.
If false, the view will be set to it's preffered height.

`var fitViewWidth:Bool`

If true, the view will always be set to the same width as the viewport.
If false, the view will be set to it's preffered width.

`var horizontalAlignment:Int`

The horizontal alignment of the view if the view is narrower than extent width. One of the following values:

AsWingConstants.RIGHT (the default)
AsWingConstants.LEFT
AsWingConstants.CENTER

`var horizontalBlockIncrement:Int`

The block value for the Horizontal scrolling.

`var horizontalUnitIncrement:Int`

The unit value for the Horizontal scrolling.

`var verticalAlignment:Int`

The vertical alignment of the view if the view is lower than extent height.

One of the following values:

AsWingConstants.CENTER (the default)
AsWingConstants.TOP
AsWingConstants.BOTTOM

`var verticalBlockIncrement:Int`

The block value for the Vertical scrolling.

`var verticalUnitIncrement:Int`

The unit value for the Vertical scrolling.

`var view:Component`

The view is the visible content of the JViewport.

JViewport use to manage the scroll view of a component. The component will be set size to its preferred size, then scroll in the viewport.

`var viewPosition:IntPoint`

The view's position.

It returns (0,0) if view is null.

@see setViewPosition to set view position loudly (to trigger events). @see Viewportable.setViewPosition

`function new(?view:Component = null, ?fitViewWidth:Bool = false, ?fitViewHeight:Bool = false): Void`

Create a viewport with view and size tracks properties.

See JViewport.view,JViewport.firViewWidth, JViewport.fitViewHeight

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

Add a listener to listen the viewpoat state change event.

When the viewpoat's state changed, the state is all about:

viewPosition
verticalUnitIncrement
verticalBlockIncrement
horizontalUnitIncrement
horizontalBlockIncrement

@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 ensureRectVisible(contentRect:IntRectangle, ?programmatic:Bool = true): Void`

Make a scroll or not to ensure specified rect will be visible.

contentRect	the rect to be ensure visible
programmatic	whether or not a programmatic call

`function getExtentSize(): IntDimension`

`function getViewSize(): IntDimension`

Usually the view's preffered size.

returns

the view's size, (0, 0) if view is null.

`function getViewportPane(): Component`

`function getVisibleRect(): IntRectangle`

returns

the view's visible rectangle.

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

Removes a state listener.

@see org.aswing.event.InteractiveEvent.STATE_CHANGED

listener

the listener to be removed.

`function scrollHorizontal(delta:Int): Void`

Scrolls view horizontal with delta pixels.

`function scrollRectToVisible(contentRect:IntRectangle, ?programmatic:Bool = true): Void`

`function scrollToBottomLeft(): Void`

Scrolls to view bottom left content. This will make the scrollbars of JScrollPane scrolled automatically, if it is located in a JScrollPane.

`function scrollToBottomRight(): Void`

Scrolls to view bottom right content. This will make the scrollbars of JScrollPane scrolled automatically, if it is located in a JScrollPane.

`function scrollToTopLeft(): Void`

Scrolls to view top left content. This will make the scrollbars of JScrollPane scrolled automatically, if it is located in a JScrollPane.

`function scrollToTopRight(): Void`

Scrolls to view to right content. This will make the scrollbars of JScrollPane scrolled automatically, if it is located in a JScrollPane.

`function scrollVertical(delta:Int): Void`

Scrolls view vertical with delta pixels.

`class org.aswing.JViewport extends Container`

Class Fields

`static var AUTO_INCREMENT:Int`

`static var BOTTOM:Int`

`static var CENTER:Int`

`static var LEFT:Int`

`static var RIGHT:Int`

`static var TOP:Int`

Instance Fields

`var fitViewHeight:Bool`

`var fitViewWidth:Bool`

`var horizontalAlignment:Int`

`var horizontalBlockIncrement:Int`

`var horizontalUnitIncrement:Int`

`var verticalAlignment:Int`

`var verticalBlockIncrement:Int`

`var verticalUnitIncrement:Int`

`var view:Component`

`var viewPosition:IntPoint`

`function new(?view:Component = null, ?fitViewWidth:Bool = false, ?fitViewHeight:Bool = false): Void`

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

`function ensureRectVisible(contentRect:IntRectangle, ?programmatic:Bool = true): Void`

`function getExtentSize(): IntDimension`

`function getViewSize(): IntDimension`

`function getViewportPane(): Component`

`function getVisibleRect(): IntRectangle`

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

`function scrollHorizontal(delta:Int): Void`

`function scrollRectToVisible(contentRect:IntRectangle, ?programmatic:Bool = true): Void`

`function scrollToBottomLeft(): Void`

`function scrollToBottomRight(): Void`

`function scrollToTopLeft(): Void`

`function scrollToTopRight(): Void`

`function scrollVertical(delta:Int): Void`

`function setViewPosition(p:IntPoint, ?programmatic:Bool = true): Void`