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

class TimeSeriesDataProvider

Object
  |
  +--xp.system.DispatcherObject
        |
        +--xp.data.TimeSeriesDataProvider

class TimeSeriesDataProvider
extends DispatcherObject

TimeSeriesDataProvider


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:
support@epresenterplus.com

Field Summary

public
autoload: Boolean
Should the source be automatically triggered when the source prop is set*

public
data: Array


public
dateField: String


public
dateFormatString: String


public static
dateFormatter: DateFormat


public
numberField: String


public
reverse: Boolean


Fields inherited from class xp.system.DispatcherObject

parent

Property Summary

public
length: Number (read-only)
returns the length of the underlying array*

public
source: Object (read, write)
The connector source control*

Constructor

public
TimeSeriesDataProvider ( )
constructor *

Method Summary

public
addItem ( value: Object ): Void
Appends an item to the end of the array

public
addItemAt ( index: Number, value: Object ): Void
Adds an item at the specified index

public
addItemsAt ( index: Number, newItems: Array ): Void
For adding several items to the array

public
editField ( index: Number, fieldName: String, newData: Object ): Void
Edits one field

public
getEditingData ( index: Number, fieldName: String ): Object
Gets data in a user-editable format - relaxed return type

public
getFieldValue ( index: Number, fieldName: String ): Object
Gets data in a user-editable format - relaxed return type

public
getItemAt ( index: Number ): Object
Gets the item at the specified index

public
getItemID ( index: Number ): Number
For getting a Unique ID for every item

public
removeAll ( Void ): Void
Removes all items

public
removeItemAt ( index: Number ): Object
Removes the item at the specified index


removeItemsAt ( index: Number, len: Number ): Void
For removing several items from the Array views to the model


replaceItemAt ( index: Number, itemObj: Object ): Void
Replaces the item at the specified index

public
resultHandler ( e )
callback for the connector result event*

public
setFieldValue ( index: Number, fieldName: String, newData: Object ): Void
Edits one field

public
sortItems ( compareFunc: Function, optionFlags: Number ): Void
Sorts the array by using a compare function

public
sortItemsBy ( fieldName: String, order ): Void
Sorts the array by some field of each item

public
updateViews ( event: String, first: Number, last: Number ): Void
takes a generic object, makes it into an event, and dispatches it

Methods inherited from class xp.system.DispatcherObject

addEventListener, removeEventListener, routeEvent


Field Documentation

autoload

public var autoload: Boolean
Should the source be automatically triggered when the source prop is set*

data

public var data: Array

dateField

public var dateField: String

dateFormatString

public var dateFormatString: String

dateFormatter

public static var dateFormatter: DateFormat

numberField

public var numberField: String

reverse

public var reverse: Boolean

Property Documentation

length

public length: Number (read-only)
returns the length of the underlying array*

source

public source: Object (read, write)
The connector source control*

Constructor Documentation

TimeSeriesDataProvider

public function TimeSeriesDataProvider()
constructor *

Method Documentation

addItem

public function addItem(value: Object): Void
Appends an item to the end of the array

Appends an item to the end of the array

Parameters:
value
the item to add (relaxed type for strings / objects)

addItemAt

public function addItemAt(index: Number,
 value: Object): Void
Adds an item at the specified index

Adds an item at the specified index

Parameters:
index
location in the array to insert
value
the item to add

addItemsAt

public function addItemsAt(index: Number,
 newItems: Array): Void
For adding several items to the array

Parameters:
index
the location for the items to be inserted
newItems
the array of new items to add

editField

public function editField(index: Number,
 fieldName: String,
 newData: Object): Void
Edits one field

Parameters:
index
the index of the item
fieldName
the name of the field to edit
newData
the new data for the field

getEditingData

public function getEditingData(index: Number,
 fieldName: String): Object
Gets data in a user-editable format - relaxed return type

Parameters:
index
the index of the item
fieldName
the name of the field to edit

getFieldValue

public function getFieldValue(index: Number,
 fieldName: String): Object
Gets data in a user-editable format - relaxed return type

Parameters:
index
the index of the item
fieldName
the name of the field to edit

getItemAt

public function getItemAt(index: Number): Object
Gets the item at the specified index

Gets the item at the specified index

Parameters:
index
the location of the item to return
Returns:
the item at the location

getItemID

public function getItemID(index: Number): Number
For getting a Unique ID for every item

Parameters:
index
the location of the item

removeAll

public function removeAll(Void): Void
Removes all items

Removes all items

Parameters:
Void
index the location of the item to remove

removeItemAt

public function removeItemAt(index: Number): Object
Removes the item at the specified index

Removes the item at the specified index

Parameters:
index
the location of the item to remove
Returns:
the item being deleted - relaxed return type for string / object

removeItemsAt

function removeItemsAt(index: Number,
 len: Number): Void
For removing several items from the Array views to the model

Parameters:
index
the location of the items to remove
len
the number of items to remove

replaceItemAt

function replaceItemAt(index: Number,
 itemObj: Object): Void
Replaces the item at the specified index

Replaces the item at the specified index

Parameters:
index
the location of the item to remove
itemObj

resultHandler

public function resultHandler(e)
callback for the connector result event*

setFieldValue

public function setFieldValue(index: Number,
 fieldName: String,
 newData: Object): Void
Edits one field

Parameters:
index
the index of the item
fieldName
the name of the field to edit
newData
the new data for the field

sortItems

public function sortItems(compareFunc: Function,
 optionFlags: Number): Void
Sorts the array by using a compare function

Sorts the array by using a compare function

Parameters:
compareFunc
- the function to use for comparing items
optionFlags
the options accepted by Array.sort

sortItemsBy

public function sortItemsBy(fieldName: String,
 order): Void
Sorts the array by some field of each item

Sorts the array by some field of each item

Parameters:
fieldName
the field (or array of fieldNames) upon which to sort
order
either "asc" or "desc", or the options accepted by Array.sort

updateViews

public function updateViews(event: String,
 first: Number,
 last: Number): Void
takes a generic object, makes it into an event, and dispatches it

Parameters:
event
e the object to dispatch
first
last

The documentation was generated from the following file:

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