DataObjectList Class Reference

Inheritance diagram for DataObjectList:

Collaboration diagram for DataObjectList:

Public Member Functions
abstract DataObject	acquireItem (int index)
	Acquires an item from the list at the provided index. More...
abstract DataObject	getItemTemplate ()
	Returns tree structure of the data source for individual list item. More...
abstract int	itemCount ()
	Gets the count of items in the list. More...
abstract void	releaseItem (int index)
	Release the memory resources associated with a particular item. More...
Public Member Functions inherited from DataObject
void	addChild (DataObject child)
	Adds data object as child of this object. More...
DataObject	getChild (int index)
	Retrieves a child object in given index. More...
int	getChildCount ()
	Retrieves the count of child objects in this data object. More...
int	getChildIndex (DataObject child)
	Retrieves the index of a child data object. More...
String	getName ()
	Allows to retrieve the name of the object. More...
DataObject	getParent ()
	Assigns a parent DataObject to this DataObject. More...
DataObjectType	getType ()
	Allows to retrieve the name of the object. More...
Object	getValue ()
	Gets the value as a boxed Object. More...
boolean	hasChild (DataObject child)
	Checks whether or not the child exists. More...
void	insertChild (int index, DataObject child)
	Inserts data object as child of this object, allows to specify index of the object. More...
Iterable< DataObject >	iterateChildren ()
	Gets an Iterable object used to iterate the DataObject children. More...
void	removeAllChildren ()
	Removes all children.
void	removeChild (DataObject child)
	Removes a child object from list of childs. More...
void	removeChild (int index)
	Removes a child object in given index. More...
void	setName (String name)
	Sets the name of the DataObject. More...
void	setParent (DataObject parent)
	Retrieves the parent DataObject of this DataObject. More...
Public Member Functions inherited from DataContext
ModifiedSubscriptionToken	addModifiedNotificationHandler (ModifiedSubscriptionFunction modifiedHandlerFunction)
	Allows to subscribe to modifications in this data context. More...
DataObject	getData ()
	Retrieves the root object of the underlying data tree. More...
DataContext	lookupDataContext (String relativePath)
	Performs object look up by path. More...
void	notifyModified ()
	Triggers modification procedure in this data context, which invokes the subscriptions.
void	removeModifiedNotificationHandler (DataContext.ModifiedSubscriptionToken token)
	Removes a modification subscription. More...
Public Member Functions inherited from Resource
String	getName ()
	Gets the resource name. More...
String	getUrl ()
	Gets the resource URL. More...
void	setKeepAlive (boolean keepAlive)
	Sets the keep alive flag. More...
Public Member Functions inherited from KanziObject
boolean	equals (Object object)
Domain	getDomain ()
	Returns the domain the object belongs to. More...
Metaclass	getDynamicMetaclass ()
	Returns the metaclass of the dynamic type of the object. More...
boolean	isStale ()
	Test if the object is stale i.e. More...
void	releaseOwnership ()
	Release ownership of the backing native object from this object. More...
void	removeLocalValue (PropertyType propertyType)
	Removes the local value associated with the property. More...
boolean	takeOwnership ()
	Take ownership of the backing native object in this object. More...

Static Public Member Functions
static Metaclass	getStaticMetaclass ()
	Returns the metaclass of this class. More...
Static Public Member Functions inherited from DataObject
static DataObject	create (Domain domain, String name)
	Creates a DataObject. More...
static Metaclass	getStaticMetaclass ()
	Returns the metaclass of this class. More...
Static Public Member Functions inherited from DataContext
static Metaclass	getStaticMetaclass ()
	Returns the metaclass of this class. More...
Static Public Member Functions inherited from KanziObject
static Metaclass	getStaticMetaclass ()
	Returns the metaclass of this class. More...

Protected Member Functions
	DataObjectList (Domain domain, String name, Metaclass metaclass)
	Creates a new list of a type derived from DataObjectList. More...

Additional Inherited Members
Public Attributes inherited from DataContext
AbstractMetaclass	DataContextMetaclass = new AbstractMetaclass("Kanzi.DataContext")
DynamicPropertyType< Resource >	DataContextProperty
DynamicPropertyType< Resource >	ItemsSourceProperty
Public Attributes inherited from DataObject
AbstractMetaclass	DataObjectMetaclass = new AbstractMetaclass("Kanzi.DataObject")
Public Attributes inherited from DataObjectList
AbstractMetaclass	DataObjectListMetaclass = new AbstractMetaclass("Kanzi.DataObjectList")

Constructor & Destructor Documentation

DataObjectList ( Domain  domain, String  name, Metaclass  metaclass  )

protected

Creates a new list of a type derived from DataObjectList.

Call this from constructor of your custom DataObjectList derivation.

Parameters

domain	UI Domain where this list belongs.
name	Name of the list.
metaclass	Metaclass data for this list.

Member Function Documentation

abstract DataObject acquireItem ( int  index )

abstract

Acquires an item from the list at the provided index.

Parameters

index

The item index

Returns

The DataObject

abstract DataObject getItemTemplate ( )

abstract

Returns tree structure of the data source for individual list item.

Only hierarchy and object types are valid, the data might not be.

Returns

template of an individual item

static Metaclass getStaticMetaclass ( )

static

Returns the metaclass of this class.

Returns

Static instance of metaclass of this DataObjectList.

abstract int itemCount ( )

abstract

Gets the count of items in the list.

Returns

number of items in the list

abstract void releaseItem ( int  index )

abstract

Release the memory resources associated with a particular item.

Parameters

index

The item index.