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

class RowEditor

MovieClip
  |
  +--xp.system.UIControl
        |
        +--xp.controls.Container
              |
              +--xp.controls.RowPanel
                    |
                    +--xp.controls.RowEditor

class RowEditor
extends RowPanel

Row editor for DataTable

The row editor is a container that temporarily get focus from the DataTable and allows columns to be edited. It is active whilst the current row is being edited. The control used in the edit row can and usuualy are different from the control used to display in the cells. Event the binding can be different. Data can be validated before being commited if it fails validation data is rolle dback to the original values. The edit row is created when a DataTable is creatd and persist for the lifetime of the DataTable. It can be referenced, used and modified like any other control or form.


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
styleClass: String
The name of the style class this instance will use.

Fields inherited from class xp.controls.RowPanel

cells, classInfo, columns, indent, indicator, indicatorWidth, isEditing, isInserting, selectMode, showItemIndex, styleClass

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
isEditing: Boolean (read, write)
is this row being edited*

Properties inherited from class xp.controls.RowPanel

hPosition, itemIndex

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


Method Summary

public
beginEdit ( itemIndex: Number, columnIndex: Number ): Void
Called by the host when starting to edit a new row*

public
endEdit ( save: Boolean ): Void
Called by the host when finished to edit the row*

public
getCellItem ( index: Number ): Object
returns the control in a cell

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

public
hideEditor ( save: Boolean ): Boolean
Ends the editing session and hides the row editor

public
processEnterKey ( )
Process enter key event

public
processEscapeKey ( )
Process escape key event

public
processTabKey ( )
Process tab key event

public
showEditor ( itemsSource: Object, itemIndex: Number, columnIndex: Number ): Boolean
Starts an editing session and shows the row editor

Methods inherited from class xp.controls.RowPanel

addCells, getCell, getCellCount, getClass, internalMeasure, resizeColumns, setDataContext, updateIndicatorState

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.

styleClass

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

Property Documentation

isEditing

public isEditing: Boolean (read, write)
is this row being edited*

Constructor Documentation

RowEditor

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

RowEditor are usually instantiated by a host control

Method Documentation

beginEdit

public function beginEdit(itemIndex: Number,
 columnIndex: Number): Void
Called by the host when starting to edit a new row*

endEdit

public function endEdit(save: Boolean): Void
Called by the host when finished to edit the row*

getCellItem

public function getCellItem(index: Number): Object
returns the control in a cell

Parameters:
index
the index of the cell
Returns:
the control in that cell

getClass

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

Overrides:
RowPanel.getClass in class RowPanel

hideEditor

public function hideEditor(save: Boolean): Boolean
Ends the editing session and hides the row editor

processEnterKey

public function processEnterKey()
Process enter key event

Called when the control or its children has focus bubbles up the logical hierarchy

Overrides:
Container.processEnterKey in class Container

processEscapeKey

public function processEscapeKey()
Process escape key event

Called when the control or its children has focus bubbles up the logical hierarchy

Overrides:
Container.processEscapeKey in class Container

processTabKey

public function processTabKey()
Process tab key event

Called when the control or its children has focus bubbles up the logical hierarchy Sets focus to the next control within the current activeForm

Overrides:
Container.processTabKey in class Container

showEditor

public function showEditor(itemsSource: Object,
 itemIndex: Number,
 columnIndex: Number): Boolean
Starts an editing session and shows the row editor

The documentation was generated from the following file:

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