Rogue Wave Views
Data Access Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions | Friends
IliTablePropertyManager Class Referenceabstract

Table class. More...

#include <ilviews/dataccess/tblprop.h>

Inheritance diagram for IliTablePropertyManager:
IliRefCounted

Public Member Functions

void addObserver (IliTablePropertyObserver *observer)
 Adds an observer to the property manager. More...
 
const char * getName () const
 Returns the property manager name. More...
 
virtual IlBoolean getProperty (IlInt rowno, IlInt colno, const IlvSymbol *propName, IliValue &propVal) const =0
 Returns a property value from one part of the table. More...
 
virtual IlInt getPropertyCount (IlInt rowno, IlInt colno) const =0
 Returns the number of properties attached to the part of the table. More...
 
virtual const IlvSymbolgetPropertyNameAt (IlInt rowno, IlInt colno, IlInt propIndex) const =0
 Returns a property name. More...
 
virtual IlBoolean getScopedProperty (IlInt rowno, IlInt colno, const IlvSymbol *propName, IliValue &propVal) const =0
 Returns a scoped property value from one part of the table. More...
 
IliTablegetTable () const
 Returns the table to which this property manager belongs. More...
 
virtual IlBoolean hasProperty (IlInt rowno, IlInt colno, const IlvSymbol *propName) const
 Returns IlTrue if the part of the table has a specific property. More...
 
virtual IlBoolean hasScopedProperty (IlInt rowno, IlInt colno, const IlvSymbol *propName) const
 Returns IlTrue if the part of the table has a scoped property. More...
 
void removeObserver (IliTablePropertyObserver *observer)
 Removes an observer from the property manager. More...
 
virtual void removeProperty (IlInt rowno, IlInt colno, const IlvSymbol *propName)=0
 Removes a property from one part of the table. More...
 
virtual void setProperty (IlInt rowno, IlInt colno, const IlvSymbol *propName, const IliValue &propVal)=0
 Attaches a property with a value to a part of the table. More...
 
virtual void tidy ()=0
 Removes all properties from all objects in this property manager.
 
- Public Member Functions inherited from IliRefCounted
IlInt getRefCount () const
 Returns the reference count of the object. Initially, this property is set to 0. More...
 
void lock () const
 Increments the reference count of the object.
 
void unLock () const
 Decrements the reference count of the object. More...
 

Friends

class IliTable
 

Additional Inherited Members

- Protected Member Functions inherited from IliRefCounted
virtual ~IliRefCounted ()
 This is the virtual destructor of the IliRefCounted class. More...
 

Detailed Description

Table class.

Library: dataccess

The IliTablePropertyManager class defines objects that manage properties attached to parts of a table. A property is identified by the property name and the part of the table to which it is attached. The part of the table can be one of the following:

Each property has a value represented as an IliValue object.

In addition to the member functions that manage the properties that are attached to a given part, there are member functions that access so-called scoped properties. A given part of the table has a given scoped property if it has the property of the same name or if it falls within another part of the table that has this property. For example, if a given row has a property called "background" and a cell in that row has no property of that name, the cell still has a scoped property named "background" that it inherits from its row. The order in which scoped properties are searched is cell/row/column/table.

See also
IliTable, IliTablePropertyObserver.

Accessors

Accessors provide a scriptable and uniform way to inspect and modify an object by using its base class methods IlvValueInterface::queryValue(), IlvValueInterface::queryValues(), IlvValueInterface::changeValue(), IlvValueInterface::changeValues(). This class defines the following accessors:

Method accessors

Name Return type Equivalent methods
getPropertyCount(Int row, Int col) Int getPropertyCount(row, col)
getPropertyNameAt(Int row, Int col, Int idx) String getPropertyNameAt(row, col, idx)
hasProperty(Int row, Int col, String propName) Boolean hasProperty(row, col, propName)
getProperty(Int row, Int col, String propName) Object getProperty(row, col, propName, returned)
getScopedProperty(Int row, Int col, String propName) Object getScopedProperty(row, col, propName, returned)
setStringProperty(Int row, Int col, String propName, String value) Void setProperty(row, col, propName, value)
setIntProperty(Int row, Int col, String propName, Int value) Void setProperty(row, col, propName, value)
getPropertyValue(Int row, Int col, String propName) Void getProperty(row, col, propName, returned)
getScopedPropertyValue(Int row, Int col, String propName) Void getScopedProperty(row, col, propName, returned)
setPropertyValue(Int row, Int col, String propName, Object value) Void setProperty(row, col, propName, value)
removeProperty(Int row, Int col, String propName) Void removeProperty(row, col, propName)

Member Function Documentation

void IliTablePropertyManager::addObserver ( IliTablePropertyObserver observer)

Adds an observer to the property manager.

Parameters
observerThe observer.
const char* IliTablePropertyManager::getName ( ) const

Returns the property manager name.

Returns
The name of the property manager or the empty string if the property manager has no name.
virtual IlBoolean IliTablePropertyManager::getProperty ( IlInt  rowno,
IlInt  colno,
const IlvSymbol propName,
IliValue propVal 
) const
pure virtual

Returns a property value from one part of the table.

Parameters
rownoThe row position.
colnoThe column position.
propNameThe property name.
propValThe property value.
Returns
IlTrue if successful.
virtual IlInt IliTablePropertyManager::getPropertyCount ( IlInt  rowno,
IlInt  colno 
) const
pure virtual

Returns the number of properties attached to the part of the table.

Parameters
rownoThe row position.
colnoThe column position.
Returns
The property count.
virtual const IlvSymbol* IliTablePropertyManager::getPropertyNameAt ( IlInt  rowno,
IlInt  colno,
IlInt  propIndex 
) const
pure virtual

Returns a property name.

Parameters
rownoThe row position.
colnoThe column position.
propIndexThe property index.
Returns
The property name or 0 if the index is out of bound.
virtual IlBoolean IliTablePropertyManager::getScopedProperty ( IlInt  rowno,
IlInt  colno,
const IlvSymbol propName,
IliValue propVal 
) const
pure virtual

Returns a scoped property value from one part of the table.

Parameters
rownoThe row position.
colnoThe column position.
propNameThe property name.
propValThe property value.
Returns
IlTrue if successful.
IliTable* IliTablePropertyManager::getTable ( ) const

Returns the table to which this property manager belongs.

Returns
The table.
virtual IlBoolean IliTablePropertyManager::hasProperty ( IlInt  rowno,
IlInt  colno,
const IlvSymbol propName 
) const
virtual

Returns IlTrue if the part of the table has a specific property.

Parameters
rownoThe row position.
colnoThe column position.
propNameThe property name.
Returns
IlTrue if the property is defined.
virtual IlBoolean IliTablePropertyManager::hasScopedProperty ( IlInt  rowno,
IlInt  colno,
const IlvSymbol propName 
) const
virtual

Returns IlTrue if the part of the table has a scoped property.

Parameters
rownoThe row position.
colnoThe column position.
propNameThe property name.
Returns
IlTrue if the scoped property is defined.
void IliTablePropertyManager::removeObserver ( IliTablePropertyObserver observer)

Removes an observer from the property manager.

Parameters
observerThe observer.
virtual void IliTablePropertyManager::removeProperty ( IlInt  rowno,
IlInt  colno,
const IlvSymbol propName 
)
pure virtual

Removes a property from one part of the table.

Parameters
rownoThe row position.
colnoThe column position.
propNameThe property name.
virtual void IliTablePropertyManager::setProperty ( IlInt  rowno,
IlInt  colno,
const IlvSymbol propName,
const IliValue propVal 
)
pure virtual

Attaches a property with a value to a part of the table.

Parameters
rownoThe row position.
colnoThe column position.
propNameThe property name.
propValThe property value.

© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.