DataObjectList is a specialization of DataObject for list data. More...
Public Member Functions | |
abstract DataObject | acquireItem (int index) |
Acquires an item from the list at the provided index. | |
void | close () |
Close the object, and release native resources. | |
abstract ObjectRef<? extends DataObject > | getItemTemplate () |
Returns tree structure of the data source for individual list item. | |
abstract int | itemCount () |
Gets the count of items in the list. | |
abstract void | releaseItem (int index) |
Release the memory resources associated with a particular item. | |
Public Member Functions inherited from DataObject | |
void | addChild (DataObject child) |
Adds data object as child of this object. | |
DataObject | getChild (int index) |
Retrieves a child object in given index. | |
int | getChildCount () |
Retrieves the count of child objects in this data object. | |
int | getChildIndex (DataObject child) |
Retrieves the index of a child data object. | |
String | getName () |
Allows to retrieve the name of the object. | |
DataObject | getParent () |
Retrieves the parent DataObject of this DataObject. | |
DataObjectType | getType () |
Allows to retrieve the name of the object. | |
Object | getValue () |
Gets the value as a boxed Object. | |
boolean | hasChild (DataObject child) |
Checks whether or not the child exists. | |
void | insertChild (int index, DataObject child) |
Inserts data object as child of this object, allows to specify index of the object. | |
Iterable< DataObject > | iterateChildren () |
Gets an Iterable object used to iterate the DataObject children. | |
void | removeAllChildren () |
Removes all children. | |
void | removeChild (DataObject child) |
Removes a child object from list of childs. | |
void | removeChild (int index) |
Removes a child object in given index. | |
void | setName (String name) |
Sets the name of the DataObject. | |
void | setParent (DataObject parent) |
Assigns a parent DataObject to this DataObject. | |
Public Member Functions inherited from DataContext | |
ModifiedSubscriptionToken | addModifiedNotificationHandler (ModifiedSubscriptionFunction modifiedHandlerFunction) |
Allows to subscribe to modifications in this data context. | |
DataObject | getData () |
Retrieves the root object of the underlying data tree. | |
DataContext | lookupDataContext (String relativePath) |
Performs object look up by path. | |
void | notifyModified () |
Triggers modification procedure in this data context, which invokes the subscriptions. | |
void | removeModifiedNotificationHandler (DataContext.ModifiedSubscriptionToken token) |
Removes a modification subscription. | |
Public Member Functions inherited from Resource | |
String | getUrl () |
Gets the resource URL. | |
void | setKeepAlive (boolean keepAlive) |
Sets the keep alive flag. | |
Public Member Functions inherited from KanziObject | |
boolean | equals (Object object) |
Domain | getDomain () |
Returns the domain the object belongs to. | |
Metaclass | getDynamicMetaclass () |
Returns the metaclass of the dynamic type of the object. | |
long | getNative () |
Gets a pointer to the backing C++ instance. | |
TDataType | getOptionalProperty (PropertyType< TDataType > propertyType) |
Returns the current value of a property type, but does not use the default value if there are no inputs to the property value. | |
TDataType | getProperty (PropertyType< TDataType > propertyType) |
Returns the current value of a property type. | |
int | hashCode () |
boolean | hasValue (PropertyType< TDataType > propertyType) |
Evaluates whether there are any inputs into the property value. | |
boolean | isStale () |
Test if the object is stale i.e. | |
void | removeLocalValue (PropertyType< TDataType > propertyType) |
Removes the local value associated with the property. | |
void | setProperty (PropertyType< TDataType > propertyType, TDataType value) |
Sets the local value of a property type. | |
ObjectRef< TType > | tryCreateObjectRef (Class< TType > clazz) |
Tries to create an owning ObjectRef instance to this KanziObject. | |
Static Public Attributes | |
static final Metaclass | metaclass |
The Metaclass for the class. | |
Static Public Attributes inherited from DataObject | |
static final Metaclass | metaclass |
The Metaclass for the class. | |
Static Public Attributes inherited from DataContext | |
static final Metaclass | metaclass |
The Metaclass for the class. | |
Static Public Attributes inherited from Resource | |
static final Metaclass | metaclass |
The Metaclass for the class. | |
Static Public Attributes inherited from KanziObject | |
static final Metaclass | metaclass = new AbstractMetaclass("Kanzi.Object") |
The Metaclass for the class. | |
Protected Member Functions | |
DataObjectList (Domain domain, long nativeObject, Metaclass metaclass) | |
Wraps a given native DataObjectList Called by KanziObject.connectResource(long) when connecting to a native DataObjectList. | |
void | initialize () |
Initializes the DataObjectList. | |
Static Protected Member Functions | |
static< Derived extends DataObjectList > ObjectRef< Derived > | createDerived (Domain domain, String name, Metaclass metaclass) |
Creates a derived class instance. | |
Additional Inherited Members | |
Static Public Member Functions inherited from DataObject | |
static< ObjectType extends DataObject > ObjectRef< ObjectType > | create (Domain domain, String name) |
Creates a DataObject. | |
Public Attributes inherited from ResourceMetadata | |
AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.Resource") |
Metaclass for Resource. | |
Public Attributes inherited from DataContextMetadata | |
DynamicPropertyType< Resource > | DataContextProperty |
Source of data for this node and its descendants. | |
DynamicPropertyType< Resource > | ItemsSourceProperty |
Data object which provides data sources for list items. | |
AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.DataContext") |
Metaclass for DataContext. | |
Public Attributes inherited from DataObjectMetadata | |
AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.DataObject") |
Metaclass for DataObject. | |
Public Attributes inherited from DataObjectListMetadata | |
AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.DataObjectList") |
Metaclass for DataObjectList. | |
DataObjectList is a specialization of DataObject for list data.
|
protected |
Wraps a given native DataObjectList Called by KanziObject.connectResource(long) when connecting to a native DataObjectList.
domain | UI Domain where this DataObjectList belongs |
nativeObject | Native object that is backing this DataObjectList |
metaclass | Metaclass data for this DataObjectList |
|
abstract |
Acquires an item from the list at the provided index.
index | The item index |
|
staticprotected |
Creates a derived class instance.
Call this method as part of the create method for a derived class.
domain | UI Domain where this data object belongs. |
name | Name of the data object |
metaclass | Metaclass data of the data object. |
|
abstract |
Returns tree structure of the data source for individual list item.
Only hierarchy and object types are valid, the data might not be.
Gets the count of items in the list.
Release the memory resources associated with a particular item.
index | The item index. |