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

class ScrollSelectView

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

All Known Subclasses: ScrollSelectList, TreeView
class ScrollSelectView
extends UIControl

ScrollSelectView


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:
support@epresenterplus.com Style properties - rowHeight

Field Summary

public
__alternateColor
the color of the alternate row background*

public
__backgroundColor
the color of the rows background*

public
__hGridLineColor
the color of horizontal gridlines*

public
__highlightColor
the color of the rows background when the mouse is over*

public
__selectColor
the color of the rows background when selected*

public
__selectedValueFormatter: Object
public var selectedValueFormatterOptions:String;

public
__selectedValuePath: String


public
__vGridLineColor
the color of vertical gridlines*

public
autoSync: Boolean
do we auto sync the underlying source when there is a selection

public
body: ListItemsControl
The list items holder

public
canEdit: Boolean


public
canInsert: Boolean
do we allow rows to be inserted

public static
classInfo: Object
A static class information object

public
editable: Boolean
do we allow rows to be edited

public
editorType: String


public
editRow
Reference to the edit row

public
footer
A reference to the footer row group

public
header
A reference to the header row group

public
hGridLines: Boolean
controls whether horizontal gridlines are displayed*

public
hLargeScroll: Number
The amount to scroll when the ScrollBar track is clicked

public
hscrollbar: ScrollBar
A reference to the horizontal scrollbar

public
hScrollPolicy: String
Indicates whether the horizontal scroll bar is displayed ("on") or not ("off"), or displayed when needed ("auto")..

public
hSmallScroll: Number
The amount to scroll when the ScrollBar arrows are clicked

public
isSelectionRequired: Boolean
Gets or set whether selection is required

public
scrollMode: String
Controls how we scroll - one of row,pixel,page

public
statusbar
A reference to the statusbar

public
tabStop: Boolean
Gets or sets whether a control should be included in tab navigation.

public
textHighlightColor
the color of text when the row is highlighted*

public
textSelectColor
the color of text when the row is selected*

public
titlebar
A reference to the titlebar

public
topIndex: Number
index of the first visible Row

public
useRollOver: Boolean
controls whether rows are higlighted as teh mouse rollsover*

public
vGridLines: Boolean
controls whether vertical gridlines are displayed*

public
vLargeScroll: Number
The amount to scroll when the ScrollBar track is clicked

public
vscrollbar: ScrollBar
A reference to the vertical scrollbar

public
vScrollPolicy: String
Indicates whether the vertical scroll bar is displayed ("on"), not displayed ("off"), or displayed when needed ("auto").

public
vSmallScroll: Number
The amount to scroll when the ScrollBar arrows are clicked

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
alternateColor: Object (read, write)


public
backgroundColor: Object (read, write)


public
contentHeight: Number (read-only)
the height of the content in the viewport window

public
contentPixelHeight (read-only)
The height in pixels of the content

public
contentWidth: Number (read-only)
the width of the content in the viewport window

public
hGridLineColor: Object (read, write)


public
highlightColor: Object (read, write)


public
hPosition: Number (read-only)


public
rowAutosize (read, write)
Controls whether rows can resize themselves in response to data changes

public
rowHeight: Number (read, write)
The default pixel height of rows in the list.

public
rowWidth: Number (read, write)
The max width a row can be.

public
sbHHeight: Number (read-only)
The effective width of the ScrollBar i.e. if not visible 0 , if visible the ScrollBar width

public
sbVWidth: Number (read-only)
The effective width of the ScrollBar i.e. if not visible 0 , if visible the ScrollBar width

public
selectColor: Object (read, write)


public
selectedIndex: Number (read, write)
The index of a selection in a single-selection list.

public
selectedIndices: Array (read-only)
An array of the selected items in a multiple-selection list.

public
selectedItem: Object (read, write)
The selected item in a single-selection list.

public
selectedItems: Array (read-only)
The selected item objects in a multiple-selection list.

public
selectedValue: (write)
The value from the currently selected item

public
selectedValue: Object (read)


public
selectedValueFormatter: Object (read, write)
The formmater object to the selectedValue

public
selectedValuePath: String (read, write)
The data path in the selectedItem to the selectedValue

public
selectionMode: String (read, write)
Gets or set the selection mode for the list.

public
variableRowHeight: Boolean (read, write)
Controls whether rows contain variable heigth data and can resize themselves in response to data changes

public
vGridLineColor: Object (read, write)


public
viewportHeight: viewportPixelHeight (read-only)
the height of the viewable window

public
viewportLeft (read-only)
The location of the left of the viewport

public
viewportPixelHeight (read-only)
The height in pixels of the viewport

public
viewportTop (read-only)
The location of the top of the viewport

public
viewportWidth (read-only)
the width of the viewable window

public
virtualMode: Boolean (read, write)
If true there is not a direct reltionship between a row in the ListItemsControl and a row in the ListDataSource, instead a pool of rows are constanly recycled to display data as needed. If flase there is a one to one reltionship sbetween a row and the row in the ListDataSource

public
vPosition: Number (read-only)


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


Method Summary

public
clearSelected ( ): Void
Clears all selected indices

public
drawComponent ( ): Void
Override to call resize

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

public
getItemAt ( index ): Object
given an index find the item from the source

public
getItemIndex ( item: Object ): Number
given an item find its index

public
getItemValue ( v ): Object
given an item find its value

public
getValueIndex ( value: Object ): Number
given a value find its index

public
isSelected ( index: Number ): Boolean
is the specifed row selected

public
setScrollContentVPos ( pos: Number ): Void
Set the vertical scroll position

public
setSelectedIndices ( indices: Array ): Void
Sets the selected indices in a multiple select list.

public
setSelectedItems ( items: Array ): Void
Sets the selected items in a multiple select list.

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

__alternateColor

public var __alternateColor
the color of the alternate row background*

__backgroundColor

public var __backgroundColor
the color of the rows background*

__hGridLineColor

public var __hGridLineColor
the color of horizontal gridlines*

__highlightColor

public var __highlightColor
the color of the rows background when the mouse is over*

__selectColor

public var __selectColor
the color of the rows background when selected*

__selectedValueFormatter

public var __selectedValueFormatter: Object
public var selectedValueFormatterOptions:String;

__selectedValuePath

public var __selectedValuePath: String

__vGridLineColor

public var __vGridLineColor
the color of vertical gridlines*

autoSync

public var autoSync: Boolean
do we auto sync the underlying source when there is a selection

body

public var body: ListItemsControl
The list items holder

canEdit

public var canEdit: Boolean

canInsert

public var canInsert: Boolean
do we allow rows to be inserted

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.

editable

public var editable: Boolean
do we allow rows to be edited

editorType

public var editorType: String

editRow

public var editRow
Reference to the edit row

footer

public var footer
A reference to the footer row group

header

public var header
A reference to the header row group

hGridLines

public var hGridLines: Boolean
controls whether horizontal gridlines are displayed*

hLargeScroll

public var hLargeScroll: Number
The amount to scroll when the ScrollBar track is clicked

hscrollbar

public var hscrollbar: ScrollBar
A reference to the horizontal scrollbar

hScrollPolicy

public var hScrollPolicy: String
Indicates whether the horizontal scroll bar is displayed ("on") or not ("off"), or displayed when needed ("auto")..

a string that determines whether the horizontal scroll bar is displayed; the value can be "on" or "off". The default value is "off".
If set to zero then we will auto calc a page size for u (in non-virtual its always 1) The horizontal scroll bar does measure text width
Note: List.hScrollPolicy does support the value "auto".

hSmallScroll

public var hSmallScroll: Number
The amount to scroll when the ScrollBar arrows are clicked

isSelectionRequired

public var isSelectionRequired: Boolean
Gets or set whether selection is required

If true a row will be automatically selected when the list is populated and deselection is not allowed except by selecting another row.

scrollMode

public var scrollMode: String
Controls how we scroll - one of row,pixel,page

statusbar

public var statusbar
A reference to the statusbar

tabStop

public var tabStop: Boolean
Gets or sets whether a control should be included in tab navigation.

All XPComponents use TabStop in place of TabEnabled.(tabEnabled MUST NOT be set)
By default this control is a TabStop

textHighlightColor

public var textHighlightColor
the color of text when the row is highlighted*

textSelectColor

public var textSelectColor
the color of text when the row is selected*

titlebar

public var titlebar
A reference to the titlebar

topIndex

public var topIndex: Number
index of the first visible Row

useRollOver

public var useRollOver: Boolean
controls whether rows are higlighted as teh mouse rollsover*

vGridLines

public var vGridLines: Boolean
controls whether vertical gridlines are displayed*

vLargeScroll

public var vLargeScroll: Number
The amount to scroll when the ScrollBar track is clicked

vscrollbar

public var vscrollbar: ScrollBar
A reference to the vertical scrollbar

vScrollPolicy

public var vScrollPolicy: String
Indicates whether the vertical scroll bar is displayed ("on"), not displayed ("off"), or displayed when needed ("auto").

A string that determines whether the list supports vertical scrolling. The value of this property can be "on", "off" or "auto".
The value "auto" causes a scroll bar to appear when needed.

vSmallScroll

public var vSmallScroll: Number
The amount to scroll when the ScrollBar arrows are clicked

Property Documentation

alternateColor

public alternateColor: Object (read, write)

backgroundColor

public backgroundColor: Object (read, write)

contentHeight

public contentHeight: Number (read-only)
the height of the content in the viewport window

contentPixelHeight

public contentPixelHeight (read-only)
The height in pixels of the content

contentWidth

public contentWidth: Number (read-only)
the width of the content in the viewport window

hGridLineColor

public hGridLineColor: Object (read, write)

highlightColor

public highlightColor: Object (read, write)

hPosition

public hPosition: Number (read-only)

rowAutosize

public rowAutosize (read, write)
Controls whether rows can resize themselves in response to data changes

At author time one of none,horizontal,vertical,both. At run time one of the AUTOSIZE in UIConstants

See also:
xp.system.UIConstants

rowHeight

public rowHeight: Number (read, write)
The default pixel height of rows in the list.

The default height, in pixels, of rows in the list. The font settings do not make the rows grow to fit, so setting the rowHeight property is the best way to make sure items are fully displayed. The default value is 20.

rowWidth

public rowWidth: Number (read, write)
The max width a row can be.

All row widths in the control must be equal, although the row width can be changed.

sbHHeight

public sbHHeight: Number (read-only)
The effective width of the ScrollBar i.e. if not visible 0 , if visible the ScrollBar width

sbVWidth

public sbVWidth: Number (read-only)
The effective width of the ScrollBar i.e. if not visible 0 , if visible the ScrollBar width

selectColor

public selectColor: Object (read, write)

selectedIndex

public selectedIndex: Number (read, write)
The index of a selection in a single-selection list.

the selected index of a single-selection list. The value is undefined if nothing is selected; the value is equal to the last item selected if there are multiple selections. If you assign a value to selectedIndex, any current selection is cleared and the indicated item is selected

selectedIndices

public selectedIndices: Array (read-only)
An array of the selected items in a multiple-selection list.

selectedItem

public selectedItem: Object (read, write)
The selected item in a single-selection list.

An item object in a single-selection list. (In a multiple-selection list with multiple items selected, selectedItem returns the item that was most recently selected.) If there is no selection, the value is undefined.

selectedItems

public selectedItems: Array (read-only)
The selected item objects in a multiple-selection list.

an array of the selected item objects. In a multiple-selection list, selectedItems lets you access the set of items selected as item objects.

selectedValue

public selectedValue: (write)
The value from the currently selected item

An value object in a single-selection list. (In a multiple-selection list with multiple items selected, selectedValue returns the value that was most recently selected.) If there is no selection, the value is undefined.

selectedValue

public selectedValue: Object (read)

selectedValueFormatter

public selectedValueFormatter: Object (read, write)
The formmater object to the selectedValue

selectedValuePath

public selectedValuePath: String (read, write)
The data path in the selectedItem to the selectedValue

selectionMode

public selectionMode: String (read, write)
Gets or set the selection mode for the list.

One of none,single,multiple"

variableRowHeight

public variableRowHeight: Boolean (read, write)
Controls whether rows contain variable heigth data and can resize themselves in response to data changes

Internally this sets the rowAutosize property

vGridLineColor

public vGridLineColor: Object (read, write)

viewportHeight

public viewportHeight: viewportPixelHeight (read-only)
the height of the viewable window

viewportLeft

public viewportLeft (read-only)
The location of the left of the viewport

viewportPixelHeight

public viewportPixelHeight (read-only)
The height in pixels of the viewport

viewportTop

public viewportTop (read-only)
The location of the top of the viewport

viewportWidth

public viewportWidth (read-only)
the width of the viewable window

virtualMode

public virtualMode: Boolean (read, write)
If true there is not a direct reltionship between a row in the ListItemsControl and a row in the ListDataSource, instead a pool of rows are constanly recycled to display data as needed. If flase there is a one to one reltionship sbetween a row and the row in the ListDataSource

vPosition

public vPosition: Number (read-only)

Constructor Documentation

ScrollSelectView

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

clearSelected

public function clearSelected(): Void
Clears all selected indices

drawComponent

public function drawComponent(): Void
Override to call resize

Overrides:
xp.system.UIControl.drawComponent in class xp.system.UIControl

getClass

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

Overrides:
xp.system.UIControl.getClass in class xp.system.UIControl

getItemAt

public function getItemAt(index): Object
given an index find the item from the source

getItemIndex

public function getItemIndex(item: Object): Number
given an item find its index

getItemValue

public function getItemValue(v): Object
given an item find its value

getValueIndex

public function getValueIndex(value: Object): Number
given a value find its index

isSelected

public function isSelected(index: Number): Boolean
is the specifed row selected

Overrides:
xp.system.UIControl.isSelected in class xp.system.UIControl

Parameters:
index
The index of the row to check
Returns:
True if selected otherwise false

setScrollContentVPos

public function setScrollContentVPos(pos: Number): Void
Set the vertical scroll position

Parameters:
pos
The new position

setSelectedIndices

public function setSelectedIndices(indices: Array): Void
Sets the selected indices in a multiple select list.

Parameters:
indices
An array of indices to select

setSelectedItems

public function setSelectedItems(items: Array): Void
Sets the selected items in a multiple select list.

Parameters:
items
indices An array of items to select

The documentation was generated from the following file:

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