XPComponents: class xp.controls.ListItemsControl

Main Page | Packages | Class Tree | Index | Help

Previous \| Next	Frames \| No Frames
Summary: Field \| Property \| Contructor \| Method	Detail: Field \| Property \| Contructor \| Method

xp.controls

class ListItemsControl

MovieClip
  |
  +--xp.system.UIControl
        |
        +--xp.controls.Container
              |
              +--xp.controls.ListItemsControl

All Known Subclasses: TreeItemsControl

class ListItemsControl
extends Container

Display a list of items on behalf of a hosting control

A ListItemsControl is hosted in another component. It displays a series of rows arranged in a vertical box layout.

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

The component that is hosting this ItemControl

public

rowAutosize: Number

Controls how rows are sized in the control

public

rowHeight: Number

The default row height

public

rows: Array

The rows held in this container.

public

rowWidth: Number

The default rowWidth

public

styleClass: String

The name of the style class this instance will use.

public

variableRowWidth: Boolean

Controls whether all rows are the same width

Fields inherited from class xp.controls.Container

__showStatusBar, __showTitleBar, acceptButton, cancelButton, children, classInfo, controlBar, controls, dataSource, enableBGMouseEvents, initialFocusControl, isRoot, lastFocus, layoutDescriptor, layoutId, layoutManager, rootContainer, styleClass, symbolId, tabList, tabModeWrap

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

hPosition: Number (read, write)

Hozizontal scroll position of the contents

public

length (read-only)

Returns the number of items in this items control

Properties inherited from class xp.controls.Container

childCount, footerHeight, headerHeight, innerBackground, innerBackgroundVisible, innerBorderBrush, innerBorderRadius, innerBorderStyle, innerBorderThickness, numChildren, showStatusBar, showTitleBar, status, title

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

ListItemsControl ( )

Constructor - This should not be called directly.

Method Summary

public

addItem ( itemDesc: Object ): Object

Add an item to the ItemsControl

public

cycleItems ( dir: Boolean, count: Number ): Void

Move rows from the bottom of the stack to the top or vice versa

public

getClass ( ): Function

Returns a reference to the components static class

public

getItemAt ( index: Number ): Container

Returns the item at the specifeid inded

public

resizeColumns ( rowWidth ): Void

Resizes all columns in this ListItemsControl

Methods inherited from class xp.controls.Container

addChild, addChildren, addControlBar, clearAll, createChild, destroyChildAt, getChild, getChildAt, getChildFromMouse, getClass, getFooterHeight, getHeaderHeight, getNextControl, getUIBuilder, getViewMetrics, initLayoutManager, onChildFocus, processEnterKey, processEscapeKey, registerChild, selectNextControl, setDataContext, setFocus, setMeasuredMinSize, setMeasuredSize, unregisterChild

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.

host

public var host

The component that is hosting this ItemControl

rowAutosize

public var rowAutosize: Number

Controls how rows are sized in the control

rowHeight

public var rowHeight: Number

The default row height

rows

public var rows: Array

The rows held in this container.

rowWidth

public var rowWidth: Number

The default rowWidth

styleClass

public var styleClass: String

The name of the style class this instance will use.

variableRowWidth

public var variableRowWidth: Boolean

Controls whether all rows are the same width

Property Documentation

hPosition

public hPosition

: Number (read, write)

Hozizontal scroll position of the contents

length

public length

(read-only)

Returns the number of items in this items control

Value:: the number of items in this items control

Constructor Documentation

ListItemsControl

public function ListItemsControl

()

Constructor - This should not be called directly.

ItemsControl are usually instantiated by a host

Method Documentation

addItem

public function addItem

(itemDesc: Object): Object

Add an item to the ItemsControl

Parameters:

itemDesc

An item descriptor

Returns:: The newly added item

cycleItems

public function cycleItems

(dir: Boolean,
count: Number): Void

Move rows from the bottom of the stack to the top or vice versa

Called by a host when in virtual mode to recycle unused rows during scrolling

Parameters:

dir		True if top to bottom(top index increasing) False if bottom to top(top index decreasing)
count		How many rows to shift

getClass

public function getClass

(): Function

Returns a reference to the components static class

Overrides:: Container.getClass in class Container

getItemAt

public function getItemAt

(index: Number): Container

Returns the item at the specifeid inded

Parameters:

index

The index of the requested item

Returns:: The specified item

resizeColumns

public function resizeColumns

(rowWidth): Void

Resizes all columns in this ListItemsControl

Called by the host when the width of cells has been altered by a column resize

The documentation was generated from the following file:

ListItemsControl.as, Last Modified: 10/24/2005 5:32:42 PM

AS2Doc