This class defines a Rogue Wave Server representation object that is a table. More...

#include <ilmvsw/table.h>

Inheritance diagram for IlsSwTable:

Public Member Functions
	IlsSwTable (IlsRepresentation &, const IlsRpObjModel &)
	This constructor is invoked by Rogue Wave Server when a new table representation is created. More...

virtual	~IlsSwTable ()
	Destructor.

virtual void	ackOpenView (const IlsMvValue *ackArgv, IlsCbArgNb ackArgc)
	Called by Server to acknowledge or to roll back a call to the second virtual member function `openView()` (documented above). More...

virtual IlsBoolean	beginS2CUpdate (IlsS2CTransStatus, IlsTransactionId)
	Called by the member function `IlsRepresentation::beginS2CTransaction()` on any representation object involved in the transaction. More...

virtual void	endS2CUpdate (IlsS2CTransStatus, IlsTransactionId)
	Called when the server has finished updating a representation object after a server-to-component transaction. More...

Rows and Columns
long	getRowsCount () const
	Returns the number of rows in the table.

virtual IlsBoolean	canEditColumn (IlvInt colno, IlsEditRights::Value=IlsEditRights::DEFAULT_EDIT) const
	Returns `IlsTrue` if the column positioned at colno can be edited according to the value of type `IlsEditRights::Value`.

IlvInt	getColumnNumber (IlsSvInt svIndex) const
	Returns the Rogue Wave Views index of the column indicated by the server index svIndex.

IlsSwRow *	getRow (IlvInt rowNumber) const
	Returns the row for the row identified by rowNumber.

IlsSwRow *	getCurrentRow () const
	Returns the `IlsSwRow` associated with the current row of the main data source.

Autocommit Mode
IlsBoolean	getAutoCommit ()
	Returns `IlsTrue` if the table automatically commits its modifications to the server. More...

void	setAutoCommit (IlsBoolean)
	Sets the autocommit mode for the table.

Collectors
const IlsString &	getDefaultCollector () const
	Returns the current collector used to add new rows to the table.

virtual void	setDefaultCollector (const IlsString &)
	Lets you select the collector that will be used to add new rows to the table if the view specification sets more than one collector for this table.

IlsRpAttributeId	getCollectorId (const IlsRpObjModel *objModel=0) const
	Returns the default collector attribute identifier for the table. More...

IlsSwRow *	createAndAddRowCollector (IlsSwTable parent, IlvInt rowNumber, IliTableBuffer , IlsRpObject *=0, IlsBoolean endUpdate=IlsTrue)
	Called from within the `insert row` callback to customize the addition of a row in a table. More...

Row Types
const IlsString &	getSvRowType () const
	Retrieves the type of the Server object that matches the row added to the table using the current collector.

const IlsString &	getRowType () const
	Retrieves the representation name of the row that was added to the table using the current collector.

void	setRowType (const IlsString &svType, const IlsString &rpType)
	Sets the Server object type that must used to create a new row using a collector defined on the table. More...

Attribute Identifiers
IlsRpAttributeId	colToAttributeId (IliDataSource *, IlvInt colIndex, IlvInt rowIndex=-1) const
	Returns the attribute identifier for the cell or column of the data source.

IlsRpAttributeId	colToAttributeId (IlsBoolean isPropertyDataSource, IlvInt colIndex, IlvInt rowIndex=-1) const
	Returns the attribute identifier for the cell in the main data source if the parameter isPropertyDataSource is `false`, or for the column of the property data source if the parameter isPropertyDataSource is `true`.

Property Manager
void	setTablePropertyManager (IliTablePropertyManager *propMgr)
	Sets the property manager that will be used to set properties to the Rogue Wave Views table. More...

IliTablePropertyManager *	getTablePropertyManager ()
	Returns the table property manager used to set properties to the current Rogue Wave Views table.

virtual void	transferState (IlsSwTable &oldTable, IlsBoolean transferCallbacks=IlsTrue)
	Transfers the state of the old table to the table for which the function is called. More...

Opening a View
virtual void	openSwView (const IlsString &viewName, IlsSwServerDataSource sds, IlsMvValue argv=0, IlsCbArgNb argc=0, IlsBoolean force=IlsFalse, IlsSwOpenViewCallbackType cb=0, IlsAny arg=0)
	Opens a view on the server object associated with this representation object. More...

virtual void	openSwView (const IlsString &viewName, IlsSwServerDataSource sds, IlsMvValue argv, IlsCbArgNb argc, IlsMvValue *ackArgv, IlsCbArgNb ackArgc, IlsCbArgNb resultIndex, IlsBoolean force=IlsFalse, IlsSwOpenViewCallbackType cb=0, IlsAny arg=0)
	Opens a view on the server object associated with this representation object with aknowledgement. More...

Public Member Functions inherited from IlsRpObject
virtual void	onRmRepresentation ()
	Called when the representation that owns the representation object is destroyed and invokes in turn the representation object destructor. More...

IlsBoolean	setConstAttribute (IlsRpAttributeId)
	Sets the value of a constant attribute for a representation object. More...

void	setConstAttributes ()
	Sets the value of the constant attributes of a representation object. More...

virtual IlsBoolean	setMapping (const IlsRpObject &cousin)
	Associates a new representation object with an existing Server object. More...

virtual IlsString	getLabel () const
	Returns the label of the representation object. More...

IlsRpObjectId	getId () const
	Returns the identifier of the representation object. More...

IlsRpAttributeId	getAttributeId (const IlsString &label) const
	Returns an attribute identifier from its name. More...

IlsRpAttributeId	getAttributeId (const IlsString &label, int index) const
	Returns an indexed attribute identifier from its name and its index. More...

IlsMvDataType	getAttributeType (IlsRpAttributeId) const
	Returns the attribute type of a given attribute. More...

const IlsRpObjModel *	getModel () const
	Returns a pointer to the runtime representation object model associated with the representation object. More...

IlsRepresentation *	getRepresentation () const
	Returns a pointer to the representation that owns the representation object. More...

IlsBoolean	isEditable (IlsRpAttributeId id, IlsEditRights::Value right=IlsEditRights::DEFAULT_EDIT) const
	Returns `IlsTrue` if the attribute id has the editing rights specified by the variable right.

IlsBoolean	isLocalHRef (IlsRpAttributeId id)
	Returns `IlsTrue` if the attribute id is a local hyper-reference – in other words, a hyper-reference that has no associated relation.

IlsMvRef	getReference () const
	Returns a reference object that identifies a representation object in the server-to-component protocol. More...

virtual void	beginC2SUpdate (IlsRpUpdateType)
	Initializes a set of updates on the representation object. More...

void	beginC2SUpdate ()
	Initializes a set of updates on the representation object. More...

IlsBoolean	isInC2SUpdate ()
	Returns `IlsTrue` between a call to `beginC2SUpdate()` and a call to either `endC2SUpdate()` or `discardC2SUpdate()`. Otherwise, it returns `IlsFalse`.

virtual void	endC2SUpdate ()
	Commits updates performed on the representation object. More...

virtual void	discardC2SUpdate ()
	Discards the modifications currently stored in the representation object update buffer.

virtual void	openView (const IlsString &viewName, IlsMvValue *argv=0, IlsCbArgNb argc=0, IlsBoolean force=IlsFalse)
	Requests the server to open the view viewName on the server object associated with its corresponding representation object. More...

virtual void	openView (const IlsString &viewName, IlsMvValue argv, IlsCbArgNb argc, IlsMvValue ackArgv, IlsCbArgNb ackArgc, IlsCbArgNb resultIndex, IlsBoolean force=IlsFalse)
	Identical to the previous one except that Server executes a call to the representation object function `ackOpenView()` during the acknowledgment rollback of the transaction that includes the call to `openView()`. More...

virtual void	setBoolean (IlsRpAttributeId id, IlsBoolean value)
	Called by the server when the Boolean attribute id has no associated modifier and must be set to value. More...

virtual void	setChar (IlsRpAttributeId id, char value)
	Called by the server when the attribute id of type `char` has no associated modifier and must be set to value. More...

virtual void	setShort (IlsRpAttributeId id, short value)
	Called by the server when the id attribute of type `short` has no associated modifier and must be set to value. More...

virtual void	setLong (IlsRpAttributeId id, long value)
	Called by the server when the attribute id of type `long` has no associated modifier and must be set to value. More...

virtual void	setFloat (IlsRpAttributeId id, float value)
	Called by the server when the attribute id of type `float` has no associated modifier and must be set to value. More...

virtual void	setDouble (IlsRpAttributeId id, double value)
	Called by the server when the attribute id of type `double` has no associated modifier and must be set to value. More...

virtual void	setString (IlsRpAttributeId id, const IlsString &value)
	Called by the server when the attribute id of type `IlsString` has no associated modifier and must be set to value. More...

virtual void	setAny (IlsRpAttributeId id, IlsAny value)
	Called by the server when the attribute id of type `IlsAny` has no associated modifier and must be set to value. More...

virtual void	setReference (IlsRpAttributeId id, const IlsRpObject *objectPtr)
	Called by the server when the id attribute has no associated modifier and must reference the object pointed to by objectPtr. More...

virtual void	setHRef (IlsRpAttributeId id, const IlsString &hrefLabel)
	called by the server when the label of the hyper-reference id has no associated modifier and must be set to hrefLabel. More...

virtual void	onSuppress (IlsBoolean isDestroyed=IlsFalse)
	This member function notifies the object destruction to the server. More...

virtual void	setRpStatus (IlsRpStatus)
	Requests modification of the representation status of the server object associated with the representation object in the view to which the representation is attached.

virtual IlsBoolean	onUpdate (IlsRpAttributeId id, IlsBoolean value)
	Requests the server to set the `IlsBoolean` attribute id to value. More...

virtual IlsBoolean	onUpdate (IlsRpAttributeId id, char value)
	Requests the server to set the `char` attribute id to value. More...

virtual IlsBoolean	onUpdate (IlsRpAttributeId id, short value)
	Requests the server to set the `short` attribute id to value. More...

virtual IlsBoolean	onUpdate (IlsRpAttributeId id, long value)
	Requests the server to set the `long` attribute id to value. More...

virtual IlsBoolean	onUpdate (IlsRpAttributeId id, float value)
	Requests the server to set the `float` attribute id to value. More...

virtual IlsBoolean	onUpdate (IlsRpAttributeId id, double value)
	Requests the server to set the `double` attribute id to value. More...

virtual IlsBoolean	onUpdate (IlsRpAttributeId id, const IlsString &value)
	Requests the server to set the `IlsString` attribute id to value. More...

virtual IlsBoolean	onUpdate (IlsRpAttributeId id, IlsAny value)
	Requests the server to set the `IlsAny` attribute id to value. More...

virtual IlsBoolean	onUpdate (IlsRpAttributeId id, const IlsMvUserType &value)
	Requests the server to set the `IlsMvUserType` attribute id to value. More...

virtual IlsBoolean	onUpdate (IlsRpAttributeId id, const IlsRpObject &objRef)
	Requests the server to set the attribute id of a reference to another representation object. More...

virtual IlsBoolean	onUpdate (IlsRpAttributeId id, const IlsRpObject &newHRefOwner, IlsRpAttributeId newHRef)
	Requests the server to replace the target object of a Server relation with another object. More...

virtual IlsBoolean	onNullifyRef (IlsRpAttributeId id)
	Requests the server to reset the reference attribute id to null, so as to notify the server about this modification. More...

virtual IlsBoolean	isMatchingRef (IlsRpAttributeId id, const IlsRpObject *newTarget)
	Tests whether the `id` attribute can be assigned the value of the object pointed to by `newTarget`. More...

virtual IlsBoolean	isMatchingHRef (IlsRpAttributeId id, const IlsRpObject *newHRefOwner, IlsRpAttributeId newHRef)
	Tests whether the id attribute can be assigned the hyper-reference identified by newHRef and belonging to newHRefOwner. More...

virtual IlsBoolean	onDereference (IlsRpAttributeId id, IlsMvValue *argv=0, IlsCbArgNb argc=0, IlsBoolean force=IlsFalse)
	Opens a view by dereferencing a hyper-reference (see Hyper-References). More...

virtual IlsBoolean	onDereference (IlsRpAttributeId id, IlsMvValue argv, IlsCbArgNb argc, IlsMvValue ackArgv, IlsCbArgNb ackArgc, IlsCbArgNb resultIndex, IlsBoolean force=IlsFalse)
	Opens a view by dereferencing a hyper-reference (see Hyper-References) with aknowledgement. More...

virtual IlsBoolean	onAddToCollection (const IlsRpObject &collectorOwner, IlsRpAttributeId collectorId)
	Requests the server to set or add a target to a relation (usually a n-ary relation). More...

virtual IlsBoolean	onRmFromCollection (const IlsRpObject &collectorOwner, IlsRpAttributeId collectorId, IlsBoolean isDestroyed=IlsFalse)
	Requests the server to remove a target in a relation (usually a n-ary relation). More...

virtual IlsBoolean	testCollection (const IlsRpObject &collectorOwner, IlsRpAttributeId collectorId)
	Tests whether the representation object can be added to the collection of objects designated by the attribute collectorId and owned by the representation object collectorOwner. More...

virtual IlsBoolean	execAsyncCallback (const IlsString &funNm, IlsMvValue *args=0, IlsCbArgNb argsNb=0, IlsBoolean inTrans=IlsTrue, IlsBoolean freeArgs=IlsFalse)
	Executes an asynchronous call to the function funNm on the Server object that matches the current representation object. More...

virtual IlsBoolean	execSyncCallback (const IlsString &funNm, IlsMvValue *args, IlsCbArgNb argsNb, IlsMvValue &result, IlsBoolean freeArgs=IlsFalse)
	Executes a synchronous call to the callback function funNm on the server object that matches the current representation object. More...

virtual IlsBoolean	execDuplexCallback (const IlsString &funNm, IlsMvValue args, IlsCbArgNb argsNb, const IlsString &duplexFunNm, IlsMvValue duplexArgs=0, IlsCbArgNb duplexNbArgs=0, IlsCbArgNb resultIndex=0, IlsBoolean inTrans=IlsTrue, IlsBoolean freeArgs=IlsFalse)
	Executes an asynchronous call to the function funNm on the server object, the representation object is bound to. More...

Static Public Member Functions
static IlvBoolean	LabelToValue (const IliFieldItf &, const char *, IliValue &)
	Must be called in the Rogue Wave Views method `labelToValue()` when deriving Rogue Wave Views gadgets so that it becomes possible to modify a hyper-reference label.

Callback Symbols
static IlvSymbol *	TableCreatedSymbol ()
	Returns the symbol for the callback that can be called when a table is created. More...

static IlvSymbol *	TableDestroyedSymbol ()
	Returns the symbol for the callback that can be called when a table is destroyed. More...

static IlvSymbol *	InsertRowSymbol ()
	Returns the symbol for the callback that can be called when a new row is about to be inserted in the table. More...

static IlvSymbol *	DeleteRowSymbol ()
	Returns the symbol for the callback that can be called when a row is about to be deleted. More...

Callbacks
static void	AddCallback (IlvSymbol symbol, IlsSwTableCallbackType, IlsAny=0, IlsSwTable =0)
	Add `IlsSwTableCallbackType` callback to the table. More...

static void	AddCallback (IlvSymbol symbol, IlsSwTableCallbackInsertRowType, IlsAny=0, IlsSwTable =0)
	Add `IlsSwTableCallbackInsertRowType` callback to the table. More...

static void	RemoveCallback (IlvSymbol symbol, IlsSwTableCallbackType, IlsAny=0, IlsSwTable =0)
	Remove `IlsSwTableCallbackType` callback previously added by `AddCallback(IlvSymbol*,IlsSwTableCallbackType,IlsAny,IlsSwTable)`

static void	RemoveCallback (IlvSymbol symbol, IlsSwTableCallbackInsertRowType, IlsAny=0, IlsSwTable =0)
	Remove `IlsSwTableCallbackInsertRowType` callback previously added by `AddCallback(IlvSymbol*,IlsSwTableCallbackInsertRowType,IlsAny,IlsSwTable)`

Protected Member Functions
virtual void	afterInit ()
	Called immediately after an object has been created when a representation object is instantiated by the Server. More...

virtual void	setUserTypeValue (IlsRpAttributeId, IlsMvUserType &value)
	Called by the server when the attribute id of type `IlsMvUserType` (or derived) has no associated modifier and must be set to value. More...

Protected Member Functions inherited from IlsRpObject
	IlsRpObject (const IlsRpObject &collectorOwner, IlsRpAttributeId collectorAttrId, const IlsRpObjModel *model=0, IlsBoolean endUpdate=IlsTrue)
	Constructor used to create object from a collector. More...

	IlsRpObject (IlsRepresentation &rp, const IlsRpObjModel &model)
	Constructor used by the notification engine. More...

virtual	~IlsRpObject ()
	Destructor. More...

virtual void	beforeDeletion (IlsTransactionId id)
	Called between the `beginS2CUpdate() and the`endS2CUpdate()` in the transaction that deletes the RpObject. More...

virtual IlsBoolean	ackAttrUpdate (IlsRpAttributeId attrId, IlsS2CTransStatus transStatus, IlsTransactionId transId)
	Called for each attribute involved in a server-to-component transaction, except if the propagation has been aborted (see `beginS2CUpdate()` above). More...

Data Sources
IliMemoryDataSource *	getMainDataSource () const
	Returns the main data source of a table.

IliMemoryDataSource *	getPropertyDataSource () const
	Returns the property data source of a table.

virtual IlsBoolean	emptyDataSource ()
	Called when an instance of `IlsSwTable` connects to an existing data source. More...

Cells
virtual IlsBoolean	updateCell (const IliValue &, IlvInt colNumber, IlsSwRow *=0)
	Calls the function `IlsRpObject::onUpdate()` for the attribute associated with the row, or for the attribute associated with the property table if the row parameter is null. More...

virtual void	setPropertyCell (const IlsString &colName, const IliValue &value)
	Called by the server to update the cell located at column colName in the property data source.

Dereferencing
void	propertySwOnDereference (IlvInt colIndex, IlsSwServerDataSource ds, IlsMvValue argv=0, IlsCbArgNb argc=0, IlsBoolean force=IlsFalse, IlsSwOpenViewCallbackType cb=0, IlsAny arg=0)
	Dereferences the hyper-reference at the Rogue Wave Views column colIndex of the property data source. More...

void	propertySwOnDereference (IlvInt colIndex, IlsSwServerDataSource ds, IlsMvValue argv, IlsCbArgNb argc, IlsMvValue *ackArgv, IlsCbArgNb ackArgc, IlsCbArgNb resIndex, IlsBoolean force=IlsFalse, IlsSwOpenViewCallbackType cb=0, IlsAny arg=0)
	Dereference the hyper-reference at the Rogue Wave Views column colNumber of the property data source, with acknowledgement. More...

virtual void	onSwDereference (IlsRpAttributeId, IlsSwServerDataSource ds, IlsMvValue argv, IlsCbArgNb argc, IlsMvValue *ackArgv, IlsCbArgNb ackArgc, IlsCbArgNb resIndex, IlsBoolean force=IlsFalse, IlsSwOpenViewCallbackType cb=0, IlsAny arg=0)
	Dereferences the attribute specified if it is a valid hyper-reference, otherwise it has no effect. More...

Detailed Description

This class defines a Rogue Wave Server representation object that is a table.

Library: mvsw

This class also defines a set of properties that are described in section IlsSwTable of Chapter Rogue Wave Server/Rogue Wave Views Mapping in the Rogue Wave Server User's Guide.

See also: IlsSwComponent, IlsSwRow.

Constructor & Destructor Documentation

◆ IlsSwTable()

IlsSwTable::IlsSwTable	(	IlsRepresentation &	,
		const IlsRpObjModel &
	)

This constructor is invoked by Rogue Wave Server when a new table representation is created.

If you derive this class, you must call this constructor with its repres and model arguments.

Member Function Documentation

◆ ackOpenView()

virtual void IlsSwTable::ackOpenView	(	const IlsMvValue *	ackArgv,
		IlsCbArgNb	ackArgc
	)

virtual

Called by Server to acknowledge or to roll back a call to the second virtual member function openView() (documented above).

The default implementation does nothing. It can be overridden.

Reimplemented from IlsRpObject.

◆ AddCallback() [1/2]

static void IlsSwTable::AddCallback	(	IlvSymbol *	symbol,
		IlsSwTableCallbackInsertRowType	,
		IlsAny	= `0`,
		IlsSwTable *	= `0`
	)

static

Add IlsSwTableCallbackInsertRowType callback to the table.

If the table parameter is null, the callback is called for all instances of IlsSwTable.

◆ AddCallback() [2/2]

static void IlsSwTable::AddCallback	(	IlvSymbol *	symbol,
		IlsSwTableCallbackType	,
		IlsAny	= `0`,
		IlsSwTable *	= `0`
	)

static

Add IlsSwTableCallbackType callback to the table.

If the table parameter is null, the callback is called for all instances of IlsSwTable.

◆ afterInit()

virtual void IlsSwTable::afterInit ( )

protectedvirtual

Called immediately after an object has been created when a representation object is instantiated by the Server.

When this method has been called, the representation object has been assigned an identifier and you can use it to perform component-to-server transactions via callback member functions.

Reimplemented from IlsRpObject.

◆ beginS2CUpdate()

virtual IlsBoolean IlsSwTable::beginS2CUpdate	(	IlsS2CTransStatus	transStatus,
		IlsTransactionId	transId
	)

virtual

Called by the member function IlsRepresentation::beginS2CTransaction() on any representation object involved in the transaction.

The transaction status transStatus is the same as the one passed to the function IlsRepresentation::beginS2CTransaction(), except that the value of this parameter is set to ILS_S2C_NOTIFY_CREATION when a representation object is created.

This function, which can be overridden, returns IlsTrue. Its return value, or that of the overriding function, is used to control the execution of the transaction.

If the return value is IlsTrue, the notification, acknowledgement or rollback is propagated to each attribute of the representation object involved in the transaction.
If the return value is IlsFalse, the propagation aborts for this representation object.

Reimplemented from IlsRpObject.

◆ createAndAddRowCollector()

IlsSwRow* IlsSwTable::createAndAddRowCollector	(	IlsSwTable *	parent,
		IlvInt	rowNumber,
		IliTableBuffer *	,
		IlsRpObject *	= `0`,
		IlsBoolean	endUpdate = `IlsTrue`
	)

Called from within the insert row callback to customize the addition of a row in a table.

A "cousin" representation object can be passed to this method so that no new object is created in the server if the row is going to represent an existing server object.

◆ DeleteRowSymbol()

IlvSymbol * IlsSwTable::DeleteRowSymbol ( )

static

Returns the symbol for the callback that can be called when a row is about to be deleted.

This callback is called only when the deletion of the row is triggered by the component, not when the row is deleted by a server notification.

If this callback returns IlsTrue, it means that the callback has handled the deletion and Rogue Wave Server does not process any further action as a consequence of the deletion.

This callback may be useful, among other uses, to set the default collector from which the row must be deleted.

See the IlsSwTableCallbackDeleteRowType type definition for more information.

◆ emptyDataSource()

virtual IlsBoolean IlsSwTable::emptyDataSource ( )

protectedvirtual

Called when an instance of IlsSwTable connects to an existing data source.

By default, the whole data source is emptied by this connection. You can override this function and return IlsFalse if you want to keep existing rows in the data source.

◆ endS2CUpdate()

virtual void IlsSwTable::endS2CUpdate	(	IlsS2CTransStatus	transStatus,
		IlsTransactionId	transId
	)

virtual

Called when the server has finished updating a representation object after a server-to-component transaction.

The parameter values passed to this function are the same as those passed to the previous function IlsRpObject::beginS2CUpdate().

The default implementation does nothing.

Reimplemented from IlsRpObject.

◆ getAutoCommit()

IlsBoolean IlsSwTable::getAutoCommit ( )

Returns IlsTrue if the table automatically commits its modifications to the server.

This is the default behavior. If the table is not in autocommit mode, the application must validate the changes in the data source before the modifications can be sent to the server.

◆ getCollectorId()

IlsRpAttributeId IlsSwTable::getCollectorId ( const IlsRpObjModel * objModel = 0 ) const

Returns the default collector attribute identifier for the table.

If a representation object model is specified, this function returns the identifier of the collector that references the row type specified by this representation object model.

Note: If more than one collector reference this row type (or a row type associated with a derived class of corresponding server type), this method returns the default collector.

This member function returns -1 if no collector has been defined or if edithRights is set to IlsFalse.

◆ InsertRowSymbol()

IlvSymbol * IlsSwTable::InsertRowSymbol ( )

static

Returns the symbol for the callback that can be called when a new row is about to be inserted in the table.

This callback is only called when the insertion of the new row is triggered by the component, not when rows are inserted into the table as a result of the Server notification mechanism. The type of the callback is IlsSwTableCallbackInsertRowType.

◆ onSwDereference()

virtual void IlsSwTable::onSwDereference	(	IlsRpAttributeId	,
		IlsSwServerDataSource *	ds,
		IlsMvValue *	argv,
		IlsCbArgNb	argc,
		IlsMvValue *	ackArgv,
		IlsCbArgNb	ackArgc,
		IlsCbArgNb	resIndex,
		IlsBoolean	force = `IlsFalse`,
		IlsSwOpenViewCallbackType	cb = `0`,
		IlsAny	arg = `0`
	)

protectedvirtual

Dereferences the attribute specified if it is a valid hyper-reference, otherwise it has no effect.

You can specify a Server data source, if you want to open the new view using an existing Server data source. If this argument is 0, Rogue Wave Server looks for a preregistered data source for this view. If none is found, a new panel is created.

You can also specify a callback and its associated data by setting the cb and arg parameters. This callback will be called when the view is opened.

You can refer to the functions IlsSwComponent::openSwView() and IlsRpObject::onDereference() for more information.

◆ openSwView() [1/2]

virtual void IlsSwTable::openSwView	(	const IlsString &	viewName,
		IlsSwServerDataSource *	sds,
		IlsMvValue *	argv,
		IlsCbArgNb	argc,
		IlsMvValue *	ackArgv,
		IlsCbArgNb	ackArgc,
		IlsCbArgNb	resultIndex,
		IlsBoolean	force = `IlsFalse`,
		IlsSwOpenViewCallbackType	cb = `0`,
		IlsAny	arg = `0`
	)

virtual

Opens a view on the server object associated with this representation object with aknowledgement.

See the function IlsSwComponent::openSwView() for a description of arguments.

◆ openSwView() [2/2]

virtual void IlsSwTable::openSwView	(	const IlsString &	viewName,
		IlsSwServerDataSource *	sds,
		IlsMvValue *	argv = `0`,
		IlsCbArgNb	argc = `0`,
		IlsBoolean	force = `IlsFalse`,
		IlsSwOpenViewCallbackType	cb = `0`,
		IlsAny	arg = `0`
	)

virtual

Opens a view on the server object associated with this representation object.

See the function IlsSwComponent::openSwView() for a description of arguments.

◆ propertySwOnDereference() [1/2]

void IlsSwTable::propertySwOnDereference	(	IlvInt	colIndex,
		IlsSwServerDataSource *	ds,
		IlsMvValue *	argv,
		IlsCbArgNb	argc,
		IlsMvValue *	ackArgv,
		IlsCbArgNb	ackArgc,
		IlsCbArgNb	resIndex,
		IlsBoolean	force = `IlsFalse`,
		IlsSwOpenViewCallbackType	cb = `0`,
		IlsAny	arg = `0`
	)

Dereference the hyper-reference at the Rogue Wave Views column colNumber of the property data source, with acknowledgement.

If the column corresponds to a selectable hyper-reference, this method calls the virtual member function IlsSwTable::onSwDereference().

◆ propertySwOnDereference() [2/2]

void IlsSwTable::propertySwOnDereference	(	IlvInt	colIndex,
		IlsSwServerDataSource *	ds,
		IlsMvValue *	argv = `0`,
		IlsCbArgNb	argc = `0`,
		IlsBoolean	force = `IlsFalse`,
		IlsSwOpenViewCallbackType	cb = `0`,
		IlsAny	arg = `0`
	)

Dereferences the hyper-reference at the Rogue Wave Views column colIndex of the property data source.

If the column corresponds to a selectable hyper-reference, this method calls the virtual member function IlsSwTable::onSwDereference().

◆ setRowType()

void IlsSwTable::setRowType	(	const IlsString &	svType,
		const IlsString &	rpType
	)

Sets the Server object type that must used to create a new row using a collector defined on the table.

This method allows you to insert objects whose type is derived from the class of the target object of the relation.

◆ setTablePropertyManager()

void IlsSwTable::setTablePropertyManager ( IliTablePropertyManager * propMgr )

Sets the property manager that will be used to set properties to the Rogue Wave Views table.

If no property manager is specified, the property manager of default Views table is used.

◆ setUserTypeValue()

virtual void IlsSwTable::setUserTypeValue	(	IlsRpAttributeId	id,
		IlsMvUserType &	value
	)

protectedvirtual

Called by the server when the attribute id of type IlsMvUserType (or derived) has no associated modifier and must be set to value.

The default implemetation does nothing.

For details on representation attribute modifiers, see the macros ILS_RP_ATTR_USERTYPE(), ILS_RP_INDEXED_ATTR_USERTYPE(), ILS_RP_DEFAULT_USERTYPE(), ILS_RP_INDEXED_DEFAULT_USERTYPE().

Reimplemented from IlsRpObject.

◆ TableCreatedSymbol()

IlvSymbol * IlsSwTable::TableCreatedSymbol ( )

static

Returns the symbol for the callback that can be called when a table is created.

The type of the callback is IlsSwTableCallbackType.

◆ TableDestroyedSymbol()

IlvSymbol * IlsSwTable::TableDestroyedSymbol ( )

static

Returns the symbol for the callback that can be called when a table is destroyed.

The type of the callback is IlsSwTableCallbackType.

◆ transferState()

virtual void IlsSwTable::transferState	(	IlsSwTable &	oldTable,
		IlsBoolean	transferCallbacks = `IlsTrue`
	)

virtual

Transfers the state of the old table to the table for which the function is called.

If the argument transferCallbacks is set to IlsTrue, the callbacks for this instance are transferred to the new table.

◆ updateCell()

virtual IlsBoolean IlsSwTable::updateCell	(	const IliValue &	,
		IlvInt	colNumber,
		IlsSwRow *	= `0`
	)

virtual

Calls the function IlsRpObject::onUpdate() for the attribute associated with the row, or for the attribute associated with the property table if the row parameter is null.

This method uses the Views-to-Server value converter registered on the instance of IlsSwComponent to convert the value to an IlsMvValue object.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Data Sources

Cells

Dereferencing

Detailed Description

Constructor & Destructor Documentation

◆ IlsSwTable()

Member Function Documentation

◆ ackOpenView()

◆ AddCallback() [1/2]

◆ AddCallback() [2/2]

◆ afterInit()

◆ beginS2CUpdate()

◆ createAndAddRowCollector()

◆ DeleteRowSymbol()

◆ emptyDataSource()

◆ endS2CUpdate()

◆ getAutoCommit()

◆ getCollectorId()

◆ InsertRowSymbol()

◆ onSwDereference()

◆ openSwView() [1/2]

◆ openSwView() [2/2]

◆ propertySwOnDereference() [1/2]

◆ propertySwOnDereference() [2/2]

◆ setRowType()

◆ setTablePropertyManager()

◆ setUserTypeValue()

◆ TableCreatedSymbol()

◆ TableDestroyedSymbol()

◆ transferState()

◆ updateCell()