Packageorg.aswing
Classpublic class JViewport
InheritanceJViewport Inheritance Container Inheritance Component Inheritance AWSprite Inheritance flash.display.Sprite
ImplementsViewportable
SubclassesGridList

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.



Public Properties
 PropertyDefined by
  BOTTOM : int = 3
[static] A fast access to AsWingConstants Constant
JViewport
 InheritedcacheAsBitmap : Boolean
AWSprite
  CENTER : int = 0
[static] A fast access to AsWingConstants Constant
JViewport
 Inheritedcontainer : Container
Component
 Inheritedfilters : Array
AWSprite
 Inheritedheight : Number
Component
  LEFT : int = 2
[static] A fast access to AsWingConstants Constant
JViewport
 Inheritedmask : DisplayObject
AWSprite
 InheritednumChildren : int
AWSprite
  RIGHT : int = 4
[static] A fast access to AsWingConstants Constant
JViewport
  TOP : int = 1
[static] A fast access to AsWingConstants Constant
JViewport
 Inheritedvisible : Boolean
Component
 Inheritedwidth : Number
Component
 Inheritedx : Number
Component
 Inheritedy : Number
Component
Protected Properties
 PropertyDefined by
 Inheritedbounds : IntRectangle
Component
 Inheritedchildren : Array
Container
 Inheritedd_numChildren : int
AWSprite
 InheriteddrawTransparentTrigger : Boolean = true
Component
 Inheritedd_visible : Boolean
Returns the DisplayObject.visible directly.
Component
 Inheritedd_x : Number
Returns DisplayObject.x directly.
Component
 Inheritedd_y : Number
Returns DisplayObject.y directly.
Component
 Inheritedlayout : LayoutManager
Container
 InheritedreadyToPaint : Boolean
Component
 Inheritedui : ComponentUI
Component
 Inheritedvalid : Boolean
Component
Public Methods
 MethodDefined by
  
JViewport(view:Component = null, tracksWidth:Boolean = false, tracksHeight:Boolean = false)
Create a viewport with view and size tracks properties.
JViewport
 Inherited
addChild(dis:DisplayObject):DisplayObject
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
AWSprite
 Inherited
addChildAt(child:DisplayObject, index:int):DisplayObject
AWSprite
 Inherited
Adds a component to be the acceptable drag initiator to this component.
Component
  
addStateListener(listener:Function, priority:int = 0, useWeakReference:Boolean = false):void
Add a listener to listen the viewpoat state change event.
JViewport
  
append(com:Component, constraints:Object = null):void
In fact just call setView(com) in this method
JViewport
 Inherited
appendAll(... coms):void
Adds one or more component to the container with null constraints
Container
 Inherited
bringToBottom(child:DisplayObject):void
Brings a child to bottom.
AWSprite
 Inherited
bringToTop(child:DisplayObject):void
Brings a child to top.
AWSprite
 Inherited
Component
 Inherited
containsChild(child:DisplayObject):Boolean
Returns whether child is directly child of this sprite, true only if getChildIndex(child) >= 0.
AWSprite
 Inherited
doLayout():void
layout this container
Container
  
ensureRectVisible(contentRect:IntRectangle, programmatic:Boolean = true):void
Make a scroll or not to ensure specified rect will be visible.
JViewport
 Inherited
fireFocusKeyDownEvent(e:KeyboardEvent):void
Component
 Inherited
fireFocusKeyUpEvent(e:KeyboardEvent):void
Component
 Inherited
getAlignmentX():Number
Returns the alignment along the x axis.
Component
 Inherited
getAlignmentY():Number
Returns the alignment along the y axis.
Component
 Inherited
getAlpha():Number
Returns the alpha of this component.
Component
 Inherited
getAwmlID():String
Returns ID used to identify components created from AWML.
Component
 Inherited
getAwmlIndex():Number
Returns position index of the component inside its AWML container.
Component
 Inherited
Returns namespace name used to identify components created from AWML.
Component
 Inherited
Gets the background color of this component.
Component
 Inherited
Returns the background decorator of this component.
Component
 Inherited
Returns the border.
Component
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
Same to DisplayObject.getBounds(), just add a explaination here that if you want to get the component bounds, see {
Component
 Inherited
getChildAt(index:int):DisplayObject
AWSprite
 Inherited
getChildByName(name:String):DisplayObject
AWSprite
 Inherited
getChildIndex(child:DisplayObject):int
AWSprite
 Inherited
Returns the value of the property with the specified key.
Component
 Inherited
Returns the clip bounds.
Component
 Inherited

Stores the bounds value of this component into "return value" rv and returns rv.

Component
 Inherited
getComponent(index:int):Component
Gets the nth(index) component in this container.
Container
 Inherited
Gets the number of components in this container.
Container
 Inherited
getConstraints():Object
Gets cpmponent's constraints.
Component
  
JViewport
  
JViewport
 Inherited
Returns the focus manager for this component's stage, or null if this component is not on stage.
Component
 Inherited
Returns the focus traversal policy of this container, it will return its parent's focus traversal policy if its self is null.
Container
 Inherited
Gets the font of this component.
Component
 Inherited
Gets the foreground color of this component.
Component
 Inherited
Returns the foreground decorator of this component.
Component
 Inherited
Stores the global location value of this component into "return value" p and returns p.
Component
 Inherited
getHeight():int
Returns the current height of this component
Component
 Inherited
Returns the current top index for a new child(none forground child).
AWSprite
  
Returns the horizontal alignment of the view if the view is narrower than extent width.
JViewport
  
Return the block value for the Horizontal scrolling.
JViewport
  
Returns the unit value for the Horizontal scrolling.
JViewport
 Inherited
Returns the index of the child component in this container.
Container
 Inherited
If a border has been set on this component, returns the border's insets; otherwise returns an empty insets.
Component
 Inherited
getInternalFocusObject():InteractiveObject
Returns the object to receive the focus for this component.
Component
 Inherited
Returns the keyboard manager of this component's JRootPane ancestor.
Component
 Inherited
Container
 Inherited
Stores the location value of this component into "return value" rv and returns rv.
Component
 Inherited
Returns the current bottom index for none background child.
AWSprite
 Inherited
Returns getMaximumSize().height
Component
 Inherited
Component
 Inherited
Returns getMaximumSize().width
Component
 Inherited
Returns getMinimumSize().height
Component
 Inherited
Component
 Inherited
Returns getMinimumSize().width
Component
 Inherited
Returns the coordinate of the mouse position, in pixels, in the component scope.
Component
 Inherited
getName():String
Returns the name of the component
Component
 Inherited
Returns the bounds that component should paint in.
Component
 Inherited
Returns the Container parent, if it parent is not a Container, null will be returned.
Component
 Inherited
Returns getPreferredSize().height
Component
 Inherited
Component
 Inherited
Returns getPreferredSize().width
Component
 Inherited
Returns the first JRootPane ancestor of this component.
Component
 Inherited
Stores the size value of this component into "return value" rv and returns rv.
Component
 Inherited
getToolTipText():String
Returns the tooltip string that has been set with setToolTipText.
Component
 Inherited
Component
  
getUIClassID():String
JViewport
  
Returns the vertical alignment of the view if the view is lower than extent height.
JViewport
  
Return the block value for the Vertical scrolling.
JViewport
  
Returns the unit value for the Vertical scrolling.
JViewport
  
JViewport
  
JViewport
  
Returns the view's position, if there is not any view, return (0,0).
JViewport
  
Usually the view's preffered size.
JViewport
 Inherited
getWidth():int
Returns the current width of this component
Component
 Inherited
getX():int
Returns the current x coordinate of the components.
Component
 Inherited
getY():int
Returns the current y coordinate of the components.
Component
 Inherited
Component
 Inherited
hitTestMouse():Boolean
Returns whether the component hit the mouse.
Component
 Inherited
hitTestObject(obj:DisplayObject):Boolean
AWSprite
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
AWSprite
  
insert(i:int, com:Component, constraints:Object = null):void
In fact just call setView(com) in this method
JViewport
 Inherited
insertAll(index:int, ... coms):void
Insets one or more component to the container with null constraints at specified starting index.
Container
 Inherited
invalidate():void
Invalidates the container.
Container
 Inherited
Clears this component and all parents above it's preferred size caches.
Component
 Inherited
Checks if the component is contained in the component hierarchy of this container.
Container
 Inherited
Returns whether or not the preferred size, minimum size and max size cache is turned on.
Component
 Inherited
isClipMasked():Boolean
Returns whether the component clip should be masked by its bounds.
AWSprite
 Inherited
Returns whether the component is acceptable drag initiator for this component.
Component
 Inherited
isDragEnabled():Boolean
Returns whether this component can fire ON_DRAG_RECOGNIZED event.
Component
 Inherited
isDropTrigger():Boolean
Returns whether this component can trigger dragging component to fire drag events when dragging over to this component.(Default value is false)
Component
 Inherited
isEnabled():Boolean
Returns whether the component is enabled.
Component
 Inherited
isFocusable():Boolean
Returns whether this Component can be focused.
Component
 Inherited
isFocusableSet():Boolean
Returns whether or not the opaque property is set by user.
Component
 Inherited
isFocusOwner():Boolean
Returns true if this Component is the focus owner.
Component
 Inherited
isFontValidated():Boolean
Returns whether the new font are applied and taked effect.
Component
 Inherited
isOnStage():Boolean
Determines whether or not this component is on stage(on the display list).
Component
 Inherited
isOpaque():Boolean
Returns true if this component is completely opaque.
Component
 Inherited
isOpaqueSet():Boolean
Returns whether or not the opaque property is set by user.
Component
 Inherited
isShowing():Boolean
Determines whether this component is showing on screen.
Component
  
isTracksHeight():Boolean
Returns whether the view tracks viewport height.
JViewport
  
isTracksWidth():Boolean
Returns whether the view tracks viewport width.
JViewport
 Inherited
isUIElement():Boolean
Returns true if this component is just a ui element component, false means this component is a regular use created component.
Component
 Inherited
isValid():Boolean
Determines whether this component is valid.
Component
 Inherited
isValidateRoot():Boolean
If this method returns true, revalidate calls by descendants of this component will cause the entire tree beginning with this root to be validated.
Component
 Inherited
isVisible():Boolean
Component
 Inherited
makeFocus():void
Makes this component's internal focus object to be the stage focus directly, without any judgement.
Component
 Inherited
pack():void
Causes this component to be sized to fit the preferred size.
Component
 Inherited
paintFocusRect(force:Boolean = false):void
Paints the focus rect if need.
Component
 Inherited
Redraw the component UI face immediately if it is visible and ready to paint.
Component
 Inherited
Calls parent reAppendChildren if parent is a container.
Component
 Inherited
putClientProperty(key:*, value:*):void
Adds an arbitrary key/value "client property" to this component.
Component
 Inherited
Removes all children and then append them with their constraints.
Container
 Inherited
reAppendToParent(constraints:Object = null):void
Removes this component from its parent and then append it with specified constraints.
Component
 Inherited
Remove the specified child component.
Container
 Inherited
removeAll():void
Remove all child components.
Container
 Inherited
Remove the specified index child component.
Container
 Inherited
removeChild(child:DisplayObject):DisplayObject
Removes a normal display object child.
Container
 Inherited
removeChildAt(index:int):DisplayObject
Removes a normal display object child with index.
Container
 Inherited
Removes a component to be the acceptable drag initiator to this component.
Component
 Inherited
Removes this component from its parent, whatever it is as a component child or only a display object child, or it's parent is just a display object container.
Component
  
removeStateListener(listener:Function):void
Removes a state listener.
JViewport
 Inherited
repaint():void
Redraws the component face next RENDER event.This method can be called often, so it needs to execute quickly.
Component
 Inherited
Component
 Inherited
requestFocus():Boolean
Requests that this Component get the input focus, and that this Component's top-level ancestor become the focused Window.
Component
 Inherited
revalidate():void
Supports deferred automatic layout.
Component
 Inherited
Component
  
scrollHorizontal(delta:int):void
Scrolls view horizontal with delta pixels.
JViewport
  
scrollRectToVisible(contentRect:IntRectangle, programmatic:Boolean = true):void
JViewport
  
Scrolls to view bottom left content.
JViewport
  
Scrolls to view bottom right content.
JViewport
  
Scrolls to view top left content.
JViewport
  
Scrolls to view to right content.
JViewport
  
scrollVertical(delta:int):void
Scrolls view vertical with delta pixels.
JViewport
 Inherited
setAlignmentX(ax:Number):void
Component
 Inherited
setAlignmentY(ay:Number):void
Component
 Inherited
setAlpha(alpha:Number):void
Indicates the alpha transparency value of the component.
Component
 Inherited
setAwmlID(id:String):void
Sets ID used to identify components created from AWML.
Component
 Inherited
setAwmlIndex(index:Number):void
Sets ID used to identify components created from AWML.
Component
 Inherited
setAwmlNamespace(theNamespace:String):void
Sets namespace used to identify components created from AWML.
Component
 Inherited
Sets the background color of this component.
Component
 Inherited
Sets a decorator to be the component background, it will represent the component background with a DisplayObject.
Component
 Inherited
setBorder(b:Border):void
Sets the border for the component, null to remove border.
Component
 Inherited
This method will call setComBounds()
Component
 Inherited
setCachePreferSizes(b:Boolean):void
Sets whether or not turn on the preferred size, minimum size and max size cache.
Component
 Inherited
setChildIndex(child:DisplayObject, index:int):void
AWSprite
 Inherited
Sets the clip bounds, a rectangle mask to make specified bounds visible.
Component
 Inherited
setClipMasked(m:Boolean):void
Sets whether the component clip should be masked by its bounds.
AWSprite
 Inherited
Sets the clip size, a rectangle mask to make specified bounds visible.
Component
 Inherited
Moves and resizes this component.
Component
 Inherited
setComBoundsXYWH(x:int, y:int, w:int, h:int):void
Moves and resizes this component.
Component
 Inherited
setConstraints(constraints:Object):void
Sets component's constraints.
Component
 Inherited
Sets a function to judge whether a component is acceptable drag initiator.
Component
 Inherited
setDragEnabled(b:Boolean):void
Sets whether this component can fire ON_DRAG_RECOGNIZED event.
Component
 Inherited
setDropTrigger(b:Boolean):void
Sets whether this component can trigger dragging component to fire drag events when dragging over to this component.
Component
 Inherited
setEnabled(b:Boolean):void
Enable or disable the component.
Component
 Inherited
setFocusable(b:Boolean):void
Sets the focusable state of this Component to the specified value.
Component
 Inherited
setFocusableSet(b:Boolean):void
Indicate that the focusable property is set by user or not.
Component
 Inherited
Sets the focus traversal policy to this container, or sets null to make this container use its parent's focus traversal policy.
Container
 Inherited
setFont(newFont:ASFont):void
Sets the text font for this component.
this method will cause a repaint and revalidate method call.
Component
 Inherited
setFontValidated(b:Boolean):void
Sets whether the new font are applied and taked effect.
Component
 Inherited
Sets the foreground color of this component.
Component
 Inherited
Sets a decorator to be the component foreground, it will represent the component foreground with a DisplayObject on top of other children of this component.
Component
 Inherited
Set the component's location in global coordinate.
Component
 Inherited
setGlobalLocationXY(x:int, y:int):void
Set the component's location in global coordinate.
Component
 Inherited
setHeight(height:Number):void
Sets the component's height.
Component
  
setHorizontalAlignment(alignment:int):void
Sets the horizontal alignment of the view if the view is narrower than extent width.
JViewport
  
setHorizontalBlockIncrement(increment:int):void
Sets the block value for the Horizontal scrolling.
JViewport
  
setHorizontalUnitIncrement(increment:int):void
Sets the unit value for the Horizontal scrolling.
JViewport
  
setLayout(layout:LayoutManager):void
JViewport
 Inherited
setLocation(newPos:IntPoint):void
Set the component's location, if it is diffs from old location, invalidate it to wait validate.
Component
 Inherited
setLocationXY(x:int, y:int):void
Component
 Inherited
setMaximumHeight(maximumHeight:int):void
Sets maximum height, -1 means auto count.
Component
 Inherited
setMaximumSize(maximumSize:IntDimension):void
setMaximumSize(d:IntDimension)
setMaximumSize(width:Number, height:Number)

Set the maximumSize, then the component's maximumSize is specified.

Component
 Inherited
setMaximumWidth(maximumWidth:int):void
Sets maximum width, -1 means auto count.
Component
 Inherited
setMinimumHeight(minimumHeight:int):void
Sets minimum height, -1 means auto count.
Component
 Inherited
setMinimumSize(minimumSize:IntDimension):void
setMinimumSize(d:IntDimension)
setMinimumSize(width:Number, height:Number)

Set the minimumSize, then the component's minimumSize is specified.

Component
 Inherited
setMinimumWidth(minimumWidth:int):void
Sets minimum width, -1 means auto count.
Component
 Inherited
setName(name:String):void
Sets the name of this component
Component
 Inherited
setOpaque(b:Boolean):void
If true the component paints every pixel within its bounds.
Component
 Inherited
setOpaqueSet(b:Boolean):void
This method will be called to set true when you set the opaque by setOpaque().
Component
 Inherited
setPreferredHeight(preferredHeight:int):void
Sets preferred width, -1 means auto count.
Component
 Inherited
setPreferredSize(preferredSize:IntDimension):void
setPreferredSize(d:IntDimension)
setPreferredSize(width:Number, height:Number)

Set the preferredSize, then the component's preferredSize is specified.

Component
 Inherited
setPreferredWidth(preferredWidth:int):void
Sets preferred width, -1 means auto count.
Component
 Inherited
setSize(newSize:IntDimension):void
Set the component's size, the width and height all will be setted to not less than zero, then set the size.
Component
 Inherited
setSizeWH(w:int, h:int):void
Component
 Inherited
setToolTipText(t:String):void
Registers the text to display in a tool tip.
Component
  
setTracksHeight(b:Boolean):void
Sets whether the view tracks viewport height.
JViewport
  
setTracksWidth(b:Boolean):void
Sets whether the view tracks viewport width.
JViewport
 Inherited
setUI(newUI:ComponentUI):void
Sets the look and feel delegate for this component.
Component
 Inherited
setUIElement(b:Boolean):void
Sets the component is a ui element or not.
Component
  
setVerticalAlignment(alignment:int):void
Sets the vertical alignment of the view if the view is lower than extent height.
JViewport
  
setVerticalBlockIncrement(increment:int):void
Sets the block value for the Vertical scrolling.
JViewport
  
setVerticalUnitIncrement(increment:int):void
Sets the unit value for the Vertical scrolling.
JViewport
  
setView(view:Component):void
Sets the view component.
JViewport
  
JViewport
  
setViewPosition(p:IntPoint, programmatic:Boolean = true):void
JViewport
 Inherited
setVisible(v:Boolean):void
Set a component to be hide or shown.
Component
 Inherited
setWidth(width:int):void
Sets the component's width.
Component
 Inherited
setX(x:int):void
Sets the x coordinate of the components.
Component
 Inherited
setY(y:int):void
Sets the y coordinate of the components.
Component
 Inherited
swapChildren(child1:DisplayObject, child2:DisplayObject):void
AWSprite
 Inherited
swapChildrenAt(index1:int, index2:int):void
AWSprite
 Inherited
toString():String
Component
 Inherited
transferFocus():Boolean
Transfers the focus to the next component, as though this Component were the focus owner.
Component
 Inherited
Transfers the focus to the previous component, as though this Component were the focus owner.
Component
  
updateUI():void
JViewport
 Inherited
validate():void
Validates this container and all of its subcomponents.
Container
Protected Methods
 MethodDefined by
 Inherited
Component
 Inherited
call the ui, if ui return null, ehn call layout to count.
Container
 Inherited
call the ui, if ui return null, ehn call layout to count.
Container
 Inherited
call the ui, if ui return null, ehn call layout to count.
Container
 Inherited
d_addChild(child:DisplayObject):DisplayObject
AWSprite
 Inherited
d_addChildAt(child:DisplayObject, index:int):DisplayObject
AWSprite
 Inherited
d_getChildAt(index:int):DisplayObject
AWSprite
 Inherited
d_getChildByName(name:String):DisplayObject
AWSprite
 Inherited
d_getChildIndex(child:DisplayObject):int
AWSprite
 Inherited
d_removeChild(child:DisplayObject):DisplayObject
AWSprite
 Inherited
d_removeChildAt(index:int):DisplayObject
AWSprite
 Inherited
d_setChildIndex(child:DisplayObject, index:int):void
AWSprite
 Inherited
d_swapChildren(child1:DisplayObject, child2:DisplayObject):void
AWSprite
 Inherited
d_swapChildrenAt(index1:int, index2:int):void
AWSprite
  
fireStateChanged(programmatic:Boolean = true):void
JViewport
 Inherited
getBackgroundChild():DisplayObject
Returns the background child.
AWSprite
 Inherited
Container
 Inherited
Container
 Inherited
Override this to return another component that the focus should be transmit to.
Component
 Inherited
getForegroundChild():DisplayObject
Returns the foreground child.
AWSprite
 Inherited
insertImp(i:int, com:Component, constraints:Object = null):void
Container
 Inherited
Makes this component and all parents above it are marked as needing to be laid out.
Component
 Inherited
isChild(child:DisplayObject):Boolean
Returns whether or not the child is this sprite's direct child.
AWSprite
 Inherited
locate():void
Locate the component to the current location.
Component
 Inherited
draw the component interface in specified bounds.
Component
 Inherited
Container
  
Restrict the view pos in valid range based on the align.
JViewport
 Inherited
setBackgroundChild(child:DisplayObject = null):void
Sets the child to be the component background, it will be add to the bottom of all other children.
AWSprite
 Inherited
AWSprite
 Inherited
setForegroundChild(child:DisplayObject = null):void
Sets the child to be the component foreground, it will be add to the top of all other children.
AWSprite
 Inherited
size():void
Do the process when size changed.
Component
Events
 EventSummaryDefined by
 Inherited Dispatched when the component is clicked continuesly.Component
 Inherited Dispatched when a component is added to a container.Container
 Inherited Dispatched when a component is removed from a container.Container
 Inherited Dispatched when a drag is drop on this component.Component
 Inherited Dispatched when a drag is enter this component area.Component
 Inherited Dispatched when a drag is exit this component area.Component
 Inherited Dispatched when the component is recongnized that it can be drag start.Component
 Inherited Dispatched when the component gained the focus from it is not the focus owner Component
 Inherited Dispatched when the key down and the component is the focus owner.Component
 Inherited Dispatched when the key up and the component is the focus owner.Component
 Inherited Dispatched when the component lost the focus from it was the focus owner.Component
 Inherited Dispatched when the component visible is set to false from true.Component
 Inherited Dispatched when the component is moved.Component
 Inherited Dispatched when the component is painted.Component
 Inherited Dispatched when the mouse released or released out side.AWSprite
 Inherited Dispatched only when the mouse released out side.AWSprite
 Inherited Dispatched when the component is resized.Component
 Inherited Dispatched when the component visible is set to true from false.Component
   Dispatched when the viewport's state changed.JViewport
Public Constants
 ConstantDefined by
  AUTO_INCREMENT : int = -2.147483648E9
[static] The default unit/block increment, it means auto count a value.
JViewport
Property detail
BOTTOMproperty
public static var BOTTOM:int = 3

A fast access to AsWingConstants Constant

See also

CENTERproperty 
public static var CENTER:int = 0

A fast access to AsWingConstants Constant

See also

LEFTproperty 
public static var LEFT:int = 2

A fast access to AsWingConstants Constant

See also

RIGHTproperty 
public static var RIGHT:int = 4

A fast access to AsWingConstants Constant

See also

TOPproperty 
public static var TOP:int = 1

A fast access to AsWingConstants Constant

See also

Constructor detail
JViewport()constructor
public function JViewport(view:Component = null, tracksWidth:Boolean = false, tracksHeight:Boolean = false)

Create a viewport with view and size tracks properties.

Parameters
view:Component (default = null)
 
tracksWidth:Boolean (default = false)
 
tracksHeight:Boolean (default = false)

See also

Method detail
addStateListener()method
public function addStateListener(listener:Function, priority:int = 0, useWeakReference:Boolean = false):void

Add a listener to listen the viewpoat state change event.

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

Parameters
listener:Function — the listener
 
priority:int (default = 0) — the priority
 
useWeakReference:Boolean (default = false) — Determines whether the reference to the listener is strong or weak.

See also

org.aswing.event.InteractiveEvent.STATE_CHANGED
append()method 
public override function append(com:Component, constraints:Object = null):void

In fact just call setView(com) in this method

Parameters
com:Component
 
constraints:Object (default = null)

See also

ensureRectVisible()method 
public function ensureRectVisible(contentRect:IntRectangle, programmatic:Boolean = true):void

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

Parameters
contentRect:IntRectangle — the rect to be ensure visible
 
programmatic:Boolean (default = true)
fireStateChanged()method 
protected function fireStateChanged(programmatic:Boolean = true):voidParameters
programmatic:Boolean (default = true)
getDefaultBasicUIClass()method 
public override function getDefaultBasicUIClass():Class

Returns
Class
getExtentSize()method 
public function getExtentSize():IntDimension

Returns
IntDimension
getHorizontalAlignment()method 
public function getHorizontalAlignment():int

Returns the horizontal alignment of the view if the view is narrower than extent width.

Returns
int — the horizontalAlignment property, one of the following values:
  • AsWingConstants.RIGHT (the default)
  • AsWingConstants.LEFT
  • AsWingConstants.CENTER
getHorizontalBlockIncrement()method 
public function getHorizontalBlockIncrement():int

Return the block value for the Horizontal scrolling.

Returns
int
getHorizontalUnitIncrement()method 
public function getHorizontalUnitIncrement():int

Returns the unit value for the Horizontal scrolling.

Returns
int
getUIClassID()method 
public override function getUIClassID():String

Returns
String
getVerticalAlignment()method 
public function getVerticalAlignment():int

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

Returns
int — the verticalAlignment property, one of the following values:
  • AsWingConstants.CENTER (the default)
  • AsWingConstants.TOP
  • AsWingConstants.BOTTOM
getVerticalBlockIncrement()method 
public function getVerticalBlockIncrement():int

Return the block value for the Vertical scrolling.

Returns
int
getVerticalUnitIncrement()method 
public function getVerticalUnitIncrement():int

Returns the unit value for the Vertical scrolling.

Returns
int
getView()method 
public function getView():Component

Returns
Component
getViewportPane()method 
public function getViewportPane():Component

Returns
Component
getViewPosition()method 
public function getViewPosition():IntPoint

Returns the view's position, if there is not any view, return (0,0).

Returns
IntPoint — the view's position, (0,0) if view is null.
getViewSize()method 
public function getViewSize():IntDimension

Usually the view's preffered size.

Returns
IntDimension — the view's size, (0, 0) if view is null.
insert()method 
public override function insert(i:int, com:Component, constraints:Object = null):void

In fact just call setView(com) in this method

Parameters
i:int
 
com:Component
 
constraints:Object (default = null)

See also

isTracksHeight()method 
public function isTracksHeight():Boolean

Returns whether the view tracks viewport height. Default is false
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.

Returns
Boolean — whether tracks height
isTracksWidth()method 
public function isTracksWidth():Boolean

Returns whether the view tracks viewport width. Default is false
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.

Returns
Boolean — whether tracks width
removeStateListener()method 
public function removeStateListener(listener:Function):void

Removes a state listener.

Parameters
listener:Function — the listener to be removed.

See also

org.aswing.event.InteractiveEvent.STATE_CHANGED
restrictionViewPos()method 
protected function restrictionViewPos(p:IntPoint):IntPoint

Restrict the view pos in valid range based on the align.

Parameters
p:IntPoint

Returns
IntPoint
scrollHorizontal()method 
public function scrollHorizontal(delta:int):void

Scrolls view horizontal with delta pixels.

Parameters
delta:int
scrollRectToVisible()method 
public function scrollRectToVisible(contentRect:IntRectangle, programmatic:Boolean = true):voidParameters
contentRect:IntRectangle
 
programmatic:Boolean (default = true)
scrollToBottomLeft()method 
public 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.

scrollToBottomRight()method 
public 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.

scrollToTopLeft()method 
public 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.

scrollToTopRight()method 
public 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.

scrollVertical()method 
public function scrollVertical(delta:int):void

Scrolls view vertical with delta pixels.

Parameters
delta:int
setHorizontalAlignment()method 
public function setHorizontalAlignment(alignment:int):void

Sets the horizontal alignment of the view if the view is narrower than extent width.

Parameters
alignment:int — one of the following values:
  • AsWingConstants.RIGHT (the default)
  • AsWingConstants.LEFT
  • AsWingConstants.CENTER
setHorizontalBlockIncrement()method 
public function setHorizontalBlockIncrement(increment:int):void

Sets the block value for the Horizontal scrolling.

Parameters
increment:int
setHorizontalUnitIncrement()method 
public function setHorizontalUnitIncrement(increment:int):void

Sets the unit value for the Horizontal scrolling.

Parameters
increment:int
setLayout()method 
public override function setLayout(layout:LayoutManager):void

Parameters
layout:LayoutManager

Throws
— if the layout is not a ViewportLayout
setTracksHeight()method 
public function setTracksHeight(b:Boolean):void

Sets whether the view tracks viewport height. Default is false
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.

Parameters
b:Boolean — tracks height
setTracksWidth()method 
public function setTracksWidth(b:Boolean):void

Sets whether the view tracks viewport width. Default is false
If true, the view will always be set to the same size as the viewport.
If false, the view will be set to it's preffered size.

Parameters
b:Boolean — tracks width
setVerticalAlignment()method 
public function setVerticalAlignment(alignment:int):void

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

Parameters
alignment:int — one of the following values:
  • AsWingConstants.CENTER (the default)
  • AsWingConstants.TOP
  • AsWingConstants.BOTTOM
setVerticalBlockIncrement()method 
public function setVerticalBlockIncrement(increment:int):void

Sets the block value for the Vertical scrolling.

Parameters
increment:int
setVerticalUnitIncrement()method 
public function setVerticalUnitIncrement(increment:int):void

Sets the unit value for the Vertical scrolling.

Parameters
increment:int
setView()method 
public function setView(view:Component):void

Sets the 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.

If the component's isTracksViewportWidth method is defined and return true, when the viewport's show size is larger than the component's, the component will be widen to the show size, otherwise, not widen. Same as isTracksViewportHeight method.

Parameters
view:Component
setViewportTestSize()method 
public function setViewportTestSize(s:IntDimension):voidParameters
s:IntDimension
setViewPosition()method 
public function setViewPosition(p:IntPoint, programmatic:Boolean = true):voidParameters
p:IntPoint
 
programmatic:Boolean (default = true)
updateUI()method 
public override function updateUI():void
Event detail
stateChangedevent 
Event object type: org.aswing.event.InteractiveEvent
InteractiveEvent.type property = org.aswing.event.InteractiveEvent.STATE_CHANGED

Dispatched when the viewport's state changed. the state is all about:

The InteractiveEvent.STATE_CHANGED constant defines the value of the type property of the event object for a stateChanged event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
isProgrammatic()True means this event is fired by the programmatic reason, false means user mouse/keyboard interaction reason.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use comp.addEventListener() to register an event listener, comp is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
Constant detail
AUTO_INCREMENTconstant
public static const AUTO_INCREMENT:int = -2.147483648E9

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