Main Page | Packages | Class Tree | Index | Help

xp.charting

class Legend

MovieClip
  |
  +--xp.system.UIControl
        |
        +--xp.charting.Legend


class Legend
extends UIControl

Legend
A container for legend text/bullet items


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
markerType: String
controls the type of markerused in the legend*

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

public
verticalGap: Number
controls the vertical spacing between items in the legend*

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

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


Method Summary

public
addItem ( label: String, color: Number ): Object
add a legend item*

public
addItemAt ( index: Number, label: String, color: Number ): Object
add a legend item at the specifed index*

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

public
getItemAt ( index: Number ): Object
return the legend label at the specified index*

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

public
removeAll ( ): Void
remove all legend items*

public
removeItem ( index: Number ): Void
remove the legend item at the specified index*

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.

markerType

public var markerType: String
controls the type of markerused in the legend*

styleClass

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

verticalGap

public var verticalGap: Number
controls the vertical spacing between items in the legend*


Constructor Documentation

Legend

public function Legend()

Method Documentation

addItem

public function addItem(label: String,
 color: Number): Object
add a legend item*

addItemAt

public function addItemAt(index: Number,
 label: String,
 color: Number): Object
add a legend item at the specifed index*

getClass

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

Overrides:

getItemAt

public function getItemAt(index: Number): Object
return the legend label at the specified index*

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.

removeAll

public function removeAll(): Void
remove all legend items*

removeItem

public function removeItem(index: Number): Void
remove the legend item at the specified index*


The documentation was generated from the following file:


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