Main Page | Packages | Class Tree | Index | Help

xp.controls

class Frame

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

All Known Subclasses: ImageBox, ScrollFrame

class Frame
extends UIControl

A content control that hold a single piece of content.

Base class for content loader/holders

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

EventTypeDescription
xp.events.ProgressEventprogressTriggered while content is loading.


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:


Field Summary

public static
classInfo: Object
A static class information object

public
hasExternalContent: Boolean


public
hasExternalImage: Boolean


public
hideImageWhileLoading: Boolean
Is the current image hidden during loading a new image

public
isContentLoaded: Boolean
Is the content loaded

public
isContentLoading: Boolean
Is the content loading

public
preloadMessage: String
Formatting string to apply to the progress label display text

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
alignPreloader: String (read, write)
Indicates the alignment of the PreLoader.

public
autoload: Boolean (read, write)
Controls whether content will be automatically loaded when the source property is set

public
content: MovieClip (read-only)
Returns a reference to the loaded content

public
nocache: Boolean (read, write)
Controls whether image caching should be blocked

public
preloadId: String (read, write)
The linkageId of a preloader image

public
source: String (read, write)
The path to the source to be loaded into this frame.

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
Frame ( )
Constructor - This should not be called directly.


Method Summary

public
drawComponent ( )
layout the control

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

public
loadContent ( ): Void
Loads or attaches the content as specified by the source property

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.

hasExternalContent

public var hasExternalContent: Boolean

hasExternalImage

public var hasExternalImage: Boolean

hideImageWhileLoading

public var hideImageWhileLoading: Boolean
Is the current image hidden during loading a new image

isContentLoaded

public var isContentLoaded: Boolean
Is the content loaded

isContentLoading

public var isContentLoading: Boolean
Is the content loading

preloadMessage

public var preloadMessage: String
Formatting string to apply to the progress label display text

This parameter is a string in the format "Loading %4%". In this string, %4 is a placeholder for the percent of task complete (content loaded).


Property Documentation

alignPreloader

public alignPreloader: String (read, write)
Indicates the alignment of the PreLoader.

Indicates the alignment of the PreLoader within the control, represented as a string.
If "left", left-aligned. If "center", centered. If "right", right-aligned. If "top", top-aligned, If "bottom", bottom aligned. If "middle" is middle aligned. The default value is middleCenter.

autoload

public autoload: Boolean (read, write)
Controls whether content will be automatically loaded when the source property is set

content

public content: MovieClip (read-only)
Returns a reference to the loaded content

nocache

public nocache: Boolean (read, write)
Controls whether image caching should be blocked

Images loaded will usually be cached.
Set this to true to prevent images from being cached.

preloadId

public preloadId: String (read, write)
The linkageId of a preloader image

An optional image can be displayed during loading of the content. If set the "PreLoadIcon" a flash logo wil be used

source

public source: String (read, write)
The path to the source to be loaded into this frame.

The source can be either a linkageId or a url of a swf or jpg.


Constructor Documentation

Frame

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

Usually Frames are not directly instantiated. See one of its subclasses.


Method Documentation

drawComponent

public function drawComponent()
layout the control

Overrides:

getClass

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

Overrides:

loadContent

public function loadContent(): Void
Loads or attaches the content as specified by the source property

The source for a frame can be either the linkageId of a libray clip or the url of an external swf or jpg.


The documentation was generated from the following file:


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