Main Page | Packages | Class Tree | Index | Help
Previous | NextFrames | No Frames
Summary: Field | Property | Contructor | MethodDetail: Field | Property | Contructor | Method
xp.controls

class ScrollView

MovieClip
  |
  +--xp.system.UIControl
        |
        +--xp.controls.ScrollView

class ScrollView
extends UIControl

A body control that contains a single piece of scrollable body.

You load body by setting the source property to the linkageId of a library object or the url of an external swf or jpg
A progress event can be subscribed to to track the load process

Event summary for the ScrollFrame class
The following table lists events of the ScrollFrame class.

EventTypeDescription
xp.events.ProgressEventprogressTriggered while body is loading.


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:
support@epresenterplus.com

Field Summary

public static
classInfo: Object
A static class information object

public
styleClass: String
The name of the style class this instance will use.

Fields inherited from class xp.system.UIControl

__layout, allowDrop, autoLayout, bindingDefaultValue, bindingFormatter, bindingPath, bindingSource, bindingType, bindingValidator, border, causesValidation, classInfo, clickOnENTER, clickOnSPACE, container, context, data, disableAcceptButton, disableCancelButton, enableBGMouseEvents, enableDblClickEvent, enableKeyDownEvents, enableKeyEvents, enableKeyUpEvents, enableMouseWheelEvents, formatterOptions, horizontalAlignment, index, isBinding, itemId, logEnabled, parent, parentContainer, parentForm, percentageHeight, percentageWidth, styleClass, tabIndex, tabStop, tooltip, tree, verticalAlignment

Property Summary

public
bodyHeight: Number (read-only)
The actual height in pixels of the body

public
bodyWidth: Number (read-only)
The actual width in pixels of the body

public
hPosition: Number (read, write)
Sets or gets the scrollable bodys horizontal position

public
hScrollPolicy: String (read, write)
Indicates whether the horizontal scrollbar is displayed ("on"), not displayed ("off"), or displayed when needed ("auto").

public
largeScroll: Number (read, write)
The number of pixels scrolled when the user clicks the track of the scroll bar.


public
smallScroll: Number (read, write)
The number of pixels scrolled when the user clicks the arrow buttons of the scroll bar.

public
viewportHeight: Number (read-only)
The actual height in pixels of the viewable window

public
viewportWidth: Number (read-only)
The actual width in pixels of the viewable window

public
vPosition: Number (read, write)
Sets or gets the scrollable body vertical position

public
vScrollPolicy: String (read, write)
Indicates whether the vertical scrollbar is displayed ("on"), not displayed ("off"), or displayed when needed ("auto").

Properties inherited from class xp.system.UIControl

alpha, autosize, background, backgroundVisible, bindings, borderBrush, borderRadius, borderShadow, borderStyle, borderThickness, bottom, dataSource, enableMouseEvents, focusManager, height, id, isEnabled, isFocused, isMouseOver, isPressed, isSelected, isValid, layout, left, margin, maxHeight, maxWidth, measuredHeight, measuredMinHeight, measuredMinWidth, measuredWidth, minHeight, minWidth, padding, readOnly, resources, right, styleName, top, triggers, visible, width, x, y

Constructor

public
ScrollView ( )
Constructor - This should not be called directly.


Method Summary

public
getClass ( ): Function
Returns a reference to the components static class

public static
newInstance ( owner, instanceId, depth, initObj )
Creates a new Instance of this class

Methods inherited from class xp.system.UIControl

addBinding, addBindings, addEventListener, addPropertyTrigger, applyStyle, beginDeferUpdate, canUpdate, centerContent, checkState, containsFocus, destroy, destroyObject, drawFocus, endDeferUpdate, findFocusFromObject, findFocusInChildren, getBinding, getBounds, getCenter, getClass, getFocus, getFocusManager, getFocusRect, getLocation, getPropertyValue, getSize, getStateName, getTrigger, globalToLocalPoint, invalidate, invalidateLayout, invalidateSize, invalidateSizeAndLayout, invalidChild, isChild, isMouseDirectlyOver, isParent, localToGlobalPoint, localToLocalPoint, measure, mouseWheel, move, onChildFocus, onKillFocus, onSetFocus, processEnterKey, processEscapeKey, processTabKey, redraw, refresh, removeEventListener, routeEvent, setBounds, setFocus, setLocation, setPropertyValue, setSize, setValueChanged, update, validate


Field Documentation

classInfo

public static var classInfo: Object
A static class information object

Every class has an associated classInfo object that holds the version and other static information. The classInfo can be accessed either directly by referencing the static class or by calling getClass() on any class instance.

styleClass

public var styleClass: String
The name of the style class this instance will use.

Property Documentation

bodyHeight

public bodyHeight: Number (read-only)
The actual height in pixels of the body

bodyWidth

public bodyWidth: Number (read-only)
The actual width in pixels of the body

hPosition

public hPosition: Number (read, write)
Sets or gets the scrollable bodys horizontal position

Callback from the ScrollTarget proxy - set the horizontal position

hScrollPolicy

public hScrollPolicy: String (read, write)
Indicates whether the horizontal scrollbar is displayed ("on"), not displayed ("off"), or displayed when needed ("auto").

A string that controls the visibility of horizontal scrollbars.
The value of this property can be "on", "off" or "auto".
The value "auto" causes a scrollbar to appear when needed.

largeScroll

public largeScroll: Number (read, write)
The number of pixels scrolled when the user clicks the track of the scroll bar.

Gets or sets the number of pixels scrolled when the user clicks the track of the ScrollBar component.

The default value is 30.

smallScroll

public smallScroll: Number (read, write)
The number of pixels scrolled when the user clicks the arrow buttons of the scroll bar.

Gets or sets the number of pixels scrolled when the user clicks the arrow buttons of the ScrollBar component.

The default value is 5.

viewportHeight

public viewportHeight: Number (read-only)
The actual height in pixels of the viewable window

viewportWidth

public viewportWidth: Number (read-only)
The actual width in pixels of the viewable window

vPosition

public vPosition: Number (read, write)
Sets or gets the scrollable body vertical position

Callback from the ScrollTarget proxy - set the vertical position

vScrollPolicy

public vScrollPolicy: String (read, write)
Indicates whether the vertical scrollbar is displayed ("on"), not displayed ("off"), or displayed when needed ("auto").

A string that controls the visibility of vertical scrollbars.
The value of this property can be "on", "off" or "auto".
The value "auto" causes a scrollbar to appear when needed.

Constructor Documentation

ScrollView

public function ScrollView()
Constructor - This should not be called directly.

If you want to dynamically create a new instance of a control use its static newInstance method

Method Documentation

getClass

public function getClass(): Function
Returns a reference to the components static class

Overrides:
xp.system.UIControl.getClass in class xp.system.UIControl

newInstance

public static function newInstance(owner,
 instanceId,
 depth,
 initObj)
Creates a new Instance of this class

Creates an instance of a component at runtime. You need to use the import statement and specify the class package name before calling this method. In addition, the component must be in the FLA file’s library.

Parameters:
owner
A reference to the movie clip or object that will contains the new Instance.
instanceId
A string indicating the instance name of the new instance.(optional)
depth
A number indicating the depth of the new instance.(optional)
initObj
An object containing initialization properties for the new instance.(optional)
Returns:
A object that is an instance of the specified class.

The documentation was generated from the following file:

Generated on 10/30/2005 9:34:02 PM by AS2Doc