Main Page | Packages | Class Tree | Index | Help

xp.controls

class ColumnHeader

MovieClip
  |
  +--xp.system.UIControl
        |
        +--xp.controls.TextBase
              |
              +--xp.controls.Label
                    |
                    +--xp.controls.ColumnHeader


class ColumnHeader
extends Label

Column headers identify columns in grid views

A column header contains:
a caption string identifying the column's content;
a column header image providing graphical information about the column's content;
sort glyph identifying the data sort order (if any) applied to the column's values;


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
column: Column
The column the cell is associated with

public
sortIcon
The library symbol of the icon set to load

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

Fields inherited from class xp.controls.Label

classInfo, styleClass

Fields inherited from class xp.controls.TextBase

leading, leftMargin, rightMargin, textIndent

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
columnIndex: Number (read-only)
This cells columnIndex

public
itemIndex: Number (read-only)
This cells itemIndex

public
sortIconIndex: String (read, write)
This selects a particular icon from the set of icons loaded

Properties inherited from class xp.controls.Label

autoEllipsis, hAnchorPoint, html, icon, iconIndex, styleSheet, vAnchorPoint

Properties inherited from class xp.controls.TextBase

font, fontBold, fontColor, fontEmbed, fontFamily, fontItalic, fontName, fontSize, fontStyle, fontUnderline, fontWeight, text, textAlign, textDecoration, textWrap

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


Method Summary

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

Methods inherited from class xp.controls.Label

drawComponent, getClass, newInstance

Methods inherited from class xp.controls.TextBase

getTextEllipsis, getTextExtent

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.

column

public var column: Column
The column the cell is associated with

sortIcon

public var sortIcon
The library symbol of the icon set to load

The icon property is the symbol of library clip. Setting this property causes the item to be loaded.

styleClass

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


Property Documentation

columnIndex

public columnIndex: Number (read-only)
This cells columnIndex

itemIndex

public itemIndex: Number (read-only)
This cells itemIndex

sortIconIndex

public sortIconIndex: String (read, write)
This selects a particular icon from the set of icons loaded

The iconIndex is the frame name or frame number the currently loaded icon should go to. Setting the index to "none" causes the icon to be hidden.


Constructor Documentation

ColumnHeader

public function ColumnHeader()
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:


The documentation was generated from the following file:


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