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

class Frameset

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

class Frameset
extends UIControl

A container of a set of Frame controls in a similar pattern to common application User Interfaces

Similar to the Java Border Layout, a central content panel with four border Frames, top, bottom,left and right.
Content can be loaded into each Frame by specifying the relevant source property
The source is either the linkageId of a library object or the url of an external swf or jpg.
The center content is commonly a MDController component.
The height and width of the border frame scan be independently set, the center frame fills all the remainig available space
A frame can be made "invisible" by setting its width or height to 0.
Frame do not resize to match their content, you must set their size explicitly.
Frames currently do not support scrolling
The Frameset emits a progress event during loading content.
The id property of the ProgressEvent will be the frame the content is loading into (centerFrame,rightFrame etc.).
The target points to the Frameset instance.

Events:
progress xp.events.ProgressEvent


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:
support@epresenterplus.com, Frame, MDController

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
bottomFrameContent: MovieClip (read-only)
Reference to the content of the bottom frame

public
bottomFrameHeight: Number (read, write)
Gets or sets the height of the bottom frame

public
bottomFrameSource: String (read, write)
Gets or sets the source property of the bottom frame

public
centerFrameContent: MovieClip (read-only)
Reference to the content of the center frame

public
centerFrameSource: String (read, write)
Gets or sets the source property of the center frame

public
frameSpacing: Number (read, write)
Gets or sets the spacing between frames

public
leftFrameContent: MovieClip (read-only)
Reference to the content of the left frame

public
leftFrameSource: String (read, write)
Gets or sets the source property of the left frame

public
leftFrameWidth: Number (read, write)
Gets or sets the width of the left frame

public
rightFrameContent: MovieClip (read-only)
Reference to the content of the right frame

public
rightFrameSource: String (read, write)
Gets or sets the source property of the right frame

public
rightFrameWidth: Number (read, write)
Gets or sets the width of the right frame

public
topFrameContent: MovieClip (read-only)
Reference to the content of the top frame

public
topFrameHeight: Number (read, write)
Gets or sets the height of the top frame

public
topFrameSource: String (read, write)
Gets or sets the source property of the top 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


Frameset ( )
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

bottomFrameContent

public bottomFrameContent: MovieClip (read-only)
Reference to the content of the bottom frame

bottomFrameHeight

public bottomFrameHeight: Number (read, write)
Gets or sets the height of the bottom frame

The default is 35

bottomFrameSource

public bottomFrameSource: String (read, write)
Gets or sets the source property of the bottom frame

centerFrameContent

public centerFrameContent: MovieClip (read-only)
Reference to the content of the center frame

centerFrameSource

public centerFrameSource: String (read, write)
Gets or sets the source property of the center frame

frameSpacing

public frameSpacing: Number (read, write)
Gets or sets the spacing between frames

The default is 2

leftFrameContent

public leftFrameContent: MovieClip (read-only)
Reference to the content of the left frame

leftFrameSource

public leftFrameSource: String (read, write)
Gets or sets the source property of the left frame

leftFrameWidth

public leftFrameWidth: Number (read, write)
Gets or sets the width of the left frame

The default is 150

rightFrameContent

public rightFrameContent: MovieClip (read-only)
Reference to the content of the right frame

rightFrameSource

public rightFrameSource: String (read, write)
Gets or sets the source property of the right frame

rightFrameWidth

public rightFrameWidth: Number (read, write)
Gets or sets the width of the right frame

The default is 150

topFrameContent

public topFrameContent: MovieClip (read-only)
Reference to the content of the top frame

topFrameHeight

public topFrameHeight: Number (read, write)
Gets or sets the height of the top frame

The default is 35

topFrameSource

public topFrameSource: String (read, write)
Gets or sets the source property of the top frame

Constructor Documentation

Frameset

function Frameset()
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