This class implements the set of IlsSwTable representation objects associated with a given dynamic view. More...

#include <ilmvsw/repres.h>

Inheritance diagram for IlsSwRepresentation:

Public Member Functions
	IlsSwRepresentation (IlsMvComponent &, const IlsRpModel &)
	Constructor. More...

virtual	~IlsSwRepresentation ()
	Destructor.

virtual void	beginC2STransaction ()
	Creates a transaction buffer where modifications performed and/or required by the application component are stored before they are sent to the server. More...

virtual IlsBoolean	beginS2CTransaction (IlsS2CTransStatus, IlsTransactionId)
	Called by the function `IlsMvComponent::beginS2CTransaction()` on each representation involved in a server-to-component transaction. More...

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

virtual void	commitC2STransaction ()
	Commits a transaction. More...

virtual void	deleteRpObject (IlsRpObject *)
	Called by the server when a representation object must be destroyed. More...

virtual void	endS2CTransaction (IlsS2CTransStatus, IlsTransactionId)
	Called at the end of a server-to-component transaction applying to the representation. More...

virtual void	endS2CUpdate (IlsS2CTransStatus, IlsTransactionId)
	Called by Rogue Wave Server at the end of the notification cycle for this object. More...

virtual void	rollbackC2STransaction ()
	Rolls back a transaction that applies * to a representation. More...

Representation Attributes
virtual void	setTitle (const IlsString &)
	Called by Rogue Wave Server when the representation attribute `title` is notified. More...

virtual void	setIconTitle (const IlsString &)
	Called by Rogue Wave Server when the representation attribute `iconTitle` is notified. More...

Raising a Panel
void	raiseOnSetSelection (IlsBoolean b)
	Specifies whether the associated panel must be raised when the function `setSelection()` is called.

IlsBoolean	raiseOnSetSelection () const
	Returns `IlsTrue` if the associated panel is raised when the function `setSelection()` is called.

virtual void	setSelection ()
	Brings the window or panel associated with the representation to the front. More...

Opening Views/Creating Panels
IlsBoolean	ownsPanel ()
	Returns `IlsTrue` if the representation owns the panel. More...

void	ownsPanel (IlsBoolean b)
	Sets or unsets ownership of the panel to the representation. More...

virtual void	onNewRpInSDS (const IlsString &viewName)
	Called when a new view is about to be opened and the representation contains a Server data source as a view parameter. More...

virtual void	onCreation (const IlsMvValue *ackArgv, IlsCbArgNb ackArgc)
	Called by Rogue Wave Server when the representation is created. More...

Index Conversion
IlvInt	serverIndexToInFormIndex (IlsSvInt i)
	Returns a Rogue Wave Views index from the server index i.

IlsSvInt	inFormIndexToServerIndex (IlvInt i)
	Returns a Rogue Wave Server index from the Rogue Wave Views index i.

Public Member Functions inherited from IlsRepresentation
virtual	~IlsRepresentation ()
	Destructor. More...

IlsRepresentationId	getId () const
	Returns the representation identifier. This identifier is unique. More...

IlsRpObject *	getObject (IlsRpObjectId id)
	Returns a pointer to the representation object identified by the argument id. More...

IlsRpObject **	getObjects (int &count)
	Returns an array of all Representation Objects stored in this representation. More...

IlsRpModel &	getModel () const
	Returns a reference to the dynamic representation model associated with the representation.

virtual IlsString	getLabel () const
	Returns the dynamic representation label, which is used in trace mode.

IlsMvComponent *	getComponent () const
	Returns a pointer to the application component to which the representation belongs. More...

IlsBoolean	isInC2STransaction ()
	Returns `IlsTrue` if the representation is being updated by the component. Otherwise, it returns `IlsFalse`.

virtual void	setMainOrigin (const IlsRpObject *rpObjP, IlsBoolean keepOldOrigin=IlsFalse)
	Requests the server to set the server object associated with the representation object pointed to by the rpObjP argument as the main origin of the view associated with the corresponding representation. More...

virtual void	addOrigin (const IlsRpObject &rpObj)
	Requests that the server add the server object associated with the rpObj representation object as an origin of the view associated to the corresponding representation. More...

virtual void	removeOrigin (const IlsRpObject &rpObj)
	Requests that the server remove the server object associated with the rpObj representation object as an origin of the view associated with the corresponding representation. More...

virtual void	close (IlsBoolean notify)
	Requests that the view associated with the representation be closed. More...

virtual void	setBufferMode (IlsBoolean incremental=IlsTrue)
	Sets the represented view in buffer mode. More...

virtual void	resetBufferMode (IlsBoolean notify=IlsTrue)
	Resets the buffer-mode state on the represented view. More...

virtual IlsRpObject *	newRpObject (IlsRepresentation &repres, IlsRpObjModel &model)
	Called to create a new representation object in the representation, based on the model representation object model, if no constructor attachment has been declared for this model. More...

void	synchronize ()
	Synchronizes the representation and its representation objects with updates that have been buffered on the view. More...

IlsBoolean	isInS2CTransaction ()
	Returns `IlsTrue` if the representation is being updated by a server. Otherwise, it returns `IlsFalse`.

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...

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	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 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	setUserTypeValue (IlsRpAttributeId id, 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...

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
Execution Callbacks
static void	DeclareExecCallback (const IlsString &, IlsSwExecCallbackType)
	Declares an execution callback by its name. More...

static IlsSwExecCallbackType	GetExecCallback (const IlsString &)
	Returns the execution callback name or `0` if no execution callback was declared.

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

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

static IlvSymbol *	IlvReadCallbackSymbol ()
	Returns the symbol for the callback that can be called when an .ilv file is read by the representation during the opening of a view. More...

static IlvSymbol *	GadgetContainerInitializedCallbackSymbol ()
	Returns the symbol for the callback that can be called when a gadget container is initialized by the representation during the opening of a view. More...

static IlvSymbol *	BeginC2STransactionSymbol ()
	Returns the symbol for the callback that can be called when a component transaction is started.

static IlvSymbol *	CommitC2STransactionSymbol ()
	Returns the symbol for the callback that can be called when a component transaction is committed.

static IlvSymbol *	RollbackC2STransactionSymbol ()
	Returns the symbol for the callback that can be called when a component transaction is rolled back.

static IlvSymbol *	BeginS2CTransactionSymbol ()
	Returns the symbol for the callback that can be called when a server transaction is started. More...

static IlvSymbol *	EndS2CTransactionSymbol ()
	Returns the symbol for the callback that can be called when a component transaction is finished. More...

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	transferState (IlsSwRepresentation &oldRepres, IlsBoolean transferCallbacks=IlsTrue)
	Transfers the state of a representation to the representation for which it is called. More...

Protected Member Functions inherited from IlsRepresentation
	IlsRepresentation (IlsMvComponent &, const IlsRpModel &)
	Protected constructor. 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...

Closing Representations
void	closeOnNewRpInSDS (IlsBoolean b)
	Controls whether the representation must be closed if a new view is opened on the same Server Data Source.

IlsBoolean	closeOnNewRpInSDS () const
	Returns `IlsTrue` if the representation is configured to be closed when a new view is opened on the same Server Data Source.

virtual void	onCloseSDS ()
	Called when the Server data source is closed without notification. More...

static void	CloseRepresentationsInPanel (IlvContainer *, IlsBoolean notify=IlsTrue)
	Closes all opened representations in this panel. More...

Accessors
IlsSwServerDataSource *	getServerDataSource () const
	Returns the corresponding Server data source. More...

const IlsString &	getResourceName ()
	Returns the name of the resource file used to create the associated panel as specified in the dynamic-view specification file.

const IlsString &	getViewType ()
	Returns the value of the default representation property. More...

IliMemoryDataSource *	getMainDataSource (const IlsString &rpName)
	Returns the main data source associated with the table representation name declared in the view specification.

IliMemoryDataSource *	getPropertyDataSource (const IlsString &rpName)
	Returns the property data source associated with the table representation name declared in the view specification.

IlsSwTable **	getTables (int &count)
	Returns an array and count of all instances of `IlsSwTable` representations that are contained by the `IlsSwRepresentation` object. More...

IlsBoolean	isBad () const
	Returns `IlsTrue` if the view has been opened and closed again immediately because its initiatialization has failed. More...

virtual IlvGadgetContainer *	getPanel () const
	Retrieves the gadget container that is associated with the representation. More...

static IlsBoolean	IsPropertyDataSource (IliDataSource *ds)
	Tests if a data source is a property data source. More...

Other Callbacks
void	addValidateCallback (IlsBoolean b)
	Sets the property `addActivateCallback` to the Boolean value b. More...

IlsBoolean	addValidateCallback ()
	Returns `IlsTrue` if the `addActivateCallback` property is set to `IlsTrue`.

static void	AddCallback (IlvSymbol symbol, IlsSwRepresentationCallbackType, IlsAny=0, IlsSwRepresentation =0)
	Add a callback to the representation. More...

static void	AddCallback (IlvSymbol symbol, IlsSwRepresentationContainerCallbackType, IlsAny=0, IlsSwRepresentation =0)
	Add a callback to the representation. More...

static void	RemoveCallback (IlvSymbol symbol, IlsSwRepresentationCallbackType, IlsAny=0, IlsSwRepresentation =0)
	Removes a callback that was previously added using `AddCallback(IlvSymbol,IlsSwRepresentationCallbackType,IlsAny,IlsSwRepresentation)` function.

static void	RemoveCallback (IlvSymbol symbol, IlsSwRepresentationContainerCallbackType, IlsAny=0, IlsSwRepresentation =0)
	Removes a callback that was previously added using `AddCallback(IlvSymbol,IlsSwRepresentationContainerCallbackType,IlsAny,IlsSwRepresentation)` function.

static void	CbDestroy (IlvView *, IlvAny)
	This static member function is installed as the destroy callback of the panel, if Rogue Wave Server creates the panel. More...

Detailed Description

This class implements the set of IlsSwTable representation objects associated with a given dynamic view.

Library: mvsw

See also: @CloseRepres, IlsMvComponent, IlsRepresentation, IlsRpObject, IlsSwComponent, IlsSwExecCallbackType, IlsSwTable, IliTable.

Constructor & Destructor Documentation

◆ IlsSwRepresentation()

IlsSwRepresentation::IlsSwRepresentation	(	IlsMvComponent &	,
		const IlsRpModel &
	)

Constructor.

This constructor is called by Rogue Wave Server when a dynamic view specified using Rogue Wave Server Studio is opened. If you derive this class, you must call this constructor with component and model arguments.

Member Function Documentation

◆ AddCallback() [1/2]

static void IlsSwRepresentation::AddCallback	(	IlvSymbol *	symbol,
		IlsSwRepresentationCallbackType	,
		IlsAny	= `0`,
		IlsSwRepresentation *	= `0`
	)

static

Add a callback to the representation.

The parameter symbol identifies which callback is to be added. If the representation is null, the callback is called for all instances of IlsSwRepresentation.

◆ AddCallback() [2/2]

static void IlsSwRepresentation::AddCallback	(	IlvSymbol *	symbol,
		IlsSwRepresentationContainerCallbackType	,
		IlsAny	= `0`,
		IlsSwRepresentation *	= `0`
	)

static

Add a callback to the representation.

The parameter symbol identifies which callback is to be added. If the representation is null, the callback is called for all instances of IlsSwRepresentation.

◆ addValidateCallback()

void IlsSwRepresentation::addValidateCallback ( IlsBoolean b )

Sets the property addActivateCallback to the Boolean value b.

When this property is set, all data source-aware gadgets of the associated panel are assigned an activate callback which will trigger the validation of the underlying data source—if this data source has been initialized in autocommit mode in the Server Data Source inspector. By default, this property is set to IlsTrue.

If you want to change this value, you must do it before the IlsRpObject::endS2CUpdate() function is called for this representation.

Warning: The following data source-aware gadgets cannot be assigned an activate callback: IliDbGrapher, IliDbGant, IliDbChart, IliDbPieChart, IliDbTree.

The callback installed on these gadgets is the static member function CbActivate(IlvGraphic*, IlvAny) (which is not documented).

◆ afterInit()

virtual void IlsSwRepresentation::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.

◆ beginC2STransaction()

virtual void IlsSwRepresentation::beginC2STransaction ( )

virtual

Creates a transaction buffer where modifications performed and/or required by the application component are stored before they are sent to the server.

It is called either explicitly or implicitly. If it is called implicitly, the commit operation is also implicit and takes place after a representation object belonging to the representation has been updated (see IlsRpObject::endC2SUpdate()).

See also: IlsRepresentation::commitC2STransaction().

Reimplemented from IlsRepresentation.

◆ beginS2CTransaction()

virtual IlsBoolean IlsSwRepresentation::beginS2CTransaction	(	IlsS2CTransStatus	st,
		IlsTransactionId
	)

virtual

Called by the function IlsMvComponent::beginS2CTransaction() on each representation involved in a server-to-component transaction.

This function takes the same arguments as those received by IlsMvComponent::beginS2CTransaction(). However, when the representation is created, the transaction status transStatus is assigned the value ILS_S2C_NOTIFY_CREATION.

If this function returns IlsTrue, the notification, acknowledgement, or rollback is propagated to each representation object touched by the transaction in this representation. If it returns IlsFalse, the transaction is aborted for this representation.

This function, which can be overridden, returns IlsTrue, unless the transaction is an acknowledgement. This means by default that an acknowledgement transaction is not propagated to the representation objects.

Reimplemented from IlsRepresentation.

◆ BeginS2CTransactionSymbol()

IlvSymbol * IlsSwRepresentation::BeginS2CTransactionSymbol ( )

static

Returns the symbol for the callback that can be called when a server transaction is started.

This callback is of type IlsSwRepresentationS2CCallbackType.

◆ beginS2CUpdate()

virtual IlsBoolean IlsSwRepresentation::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.

◆ CbDestroy()

static void IlsSwRepresentation::CbDestroy	(	IlvView *	,
		IlvAny
	)

static

This static member function is installed as the destroy callback of the panel, if Rogue Wave Server creates the panel.

The panel is created if the view is opened with no panel or Server data source supplied as parameters.

You can remove this callback using the standard Rogue Wave Views method IlvView::removeDestroyCallback() or by calling the member function IlsSwRepresentation::ownsPanel() with its Boolean parameter set to IlsFalse.

◆ CloseRepresentationsInPanel()

static void IlsSwRepresentation::CloseRepresentationsInPanel	(	IlvContainer *	,
		IlsBoolean	notify = `IlsTrue`
	)

static

Closes all opened representations in this panel.

Each representation is closed with or without notification, depending of the value of the last parameter.

◆ commitC2STransaction()

virtual void IlsSwRepresentation::commitC2STransaction ( )

virtual

Commits a transaction.

By default, the updates performed during the transaction are directly sent to the server. They can also be stored in a transaction buffer at the component level.

See also: IlsMvComponent::beginC2STransaction().

Reimplemented from IlsRepresentation.

◆ DeclareExecCallback()

static void IlsSwRepresentation::DeclareExecCallback	(	const IlsString &	,
		IlsSwExecCallbackType
	)

static

Declares an execution callback by its name.

This name can be used in Rogue Wave Server Studio as the generic callback name on the gadget. The callback function passed as parameter is called when the gadget is activated. The name to be used in the Rogue Wave Server Studio should be prefixed by @IlsRpCallback:. Hence, if we declare a callback of name doIt, the name to be set in Rogue Wave Server Studio is @IlsRpCallback:doIt.

See also: @IlsRpCallback.

◆ deleteRpObject()

virtual void IlsSwRepresentation::deleteRpObject ( IlsRpObject * obj )

virtual

Called by the server when a representation object must be destroyed.

It actually deletes the object. It can be overridden.

Reimplemented from IlsRepresentation.

◆ endS2CTransaction()

virtual void IlsSwRepresentation::endS2CTransaction	(	IlsS2CTransStatus	,
		IlsTransactionId
	)

virtual

Called at the end of a server-to-component transaction applying to the representation.

The arguments are the same as those passed to the beginS2CTransaction() function described above. This function, which can be overridden, has an empty implementation.

Reimplemented from IlsRepresentation.

◆ EndS2CTransactionSymbol()

IlvSymbol * IlsSwRepresentation::EndS2CTransactionSymbol ( )

static

Returns the symbol for the callback that can be called when a component transaction is finished.

This callback is of type IlsSwRepresentationS2CCallbackType.

◆ endS2CUpdate()

virtual void IlsSwRepresentation::endS2CUpdate	(	IlsS2CTransStatus	,
		IlsTransactionId
	)

virtual

Called by Rogue Wave Server at the end of the notification cycle for this object.

The first time this function is called, it creates the panel if no panel or Server Data Source has been supplied.

Reimplemented from IlsRpObject.

◆ GadgetContainerInitializedCallbackSymbol()

IlvSymbol * IlsSwRepresentation::GadgetContainerInitializedCallbackSymbol ( )

static

Returns the symbol for the callback that can be called when a gadget container is initialized by the representation during the opening of a view.

This callback is of type IlsSwRepresentationContainerCallbackType.

◆ getPanel()

virtual IlvGadgetContainer* IlsSwRepresentation::getPanel ( ) const

virtual

Retrieves the gadget container that is associated with the representation.

This gadget container can be one of the following:

either the container that was passed to the openView() function (either explicitly or implicitly via a call to IlsSwComponent::DeclareViewParameterContainer()),
or the container that was created by the representation from the resource name (the name of the .ilv file if the view was created in Rogue Wave Server Studio),
or the container of the provided Server Data Source.

◆ getServerDataSource()

IlsSwServerDataSource* IlsSwRepresentation::getServerDataSource ( ) const

Returns the corresponding Server data source.

Note: This information is not available until the end of the first notification cycle on this representation, that is until the function IlsSwRepresentation::endS2CUpdate() (inherited from the parent class IlsRpObject) has been called once.

◆ getTables()

IlsSwTable** IlsSwRepresentation::getTables ( int & count )

Returns an array and count of all instances of IlsSwTable representations that are contained by the IlsSwRepresentation object.

The array must be freed using delete[] when finished with.

◆ getViewType()

const IlsString& IlsSwRepresentation::getViewType ( )

Returns the value of the default representation property.

If no value has been supplied for this property through Rogue Wave Server Studio, the value is InFormView.

◆ IlvReadCallbackSymbol()

IlvSymbol * IlsSwRepresentation::IlvReadCallbackSymbol ( )

static

Returns the symbol for the callback that can be called when an .ilv file is read by the representation during the opening of a view.

This callback is of type IlsSwRepresentationContainerCallbackType.

◆ isBad()

IlsBoolean IlsSwRepresentation::isBad ( ) const

Returns IlsTrue if the view has been opened and closed again immediately because its initiatialization has failed.

It can be due to the component being wrong, or the Server Data Source or panel having been destroyed before the representation was created.

◆ IsPropertyDataSource()

static IlsBoolean IlsSwRepresentation::IsPropertyDataSource ( IliDataSource * ds )

static

Tests if a data source is a property data source.

This static member function returns:

IlsTrue if the data source parameter is the property data source,
IlsFalse if the data source is null or if it is the main data source.

◆ onCloseSDS()

virtual void IlsSwRepresentation::onCloseSDS ( )

virtual

Called when the Server data source is closed without notification.

By default, this function deletes the representation.

See also: IlsSwServerDataSource::close().

◆ onCreation()

virtual void IlsSwRepresentation::onCreation	(	const IlsMvValue *	ackArgv,
		IlsCbArgNb	ackArgc
	)

virtual

Called by Rogue Wave Server when the representation is created.

It triggers the IlsSwOpenViewCallbackType callback installed when opening the view.

Reimplemented from IlsRepresentation.

◆ onNewRpInSDS()

virtual void IlsSwRepresentation::onNewRpInSDS ( const IlsString & viewName )

virtual

Called when a new view is about to be opened and the representation contains a Server data source as a view parameter.

By default, this function closes the previous representation in which the Server data source was displayed. This method can be overridden to change the default behavior.

◆ ownsPanel() [1/2]

IlsBoolean IlsSwRepresentation::ownsPanel ( )

Returns IlsTrue if the representation owns the panel.

The representation is said to own the panel if it has been created without a panel or a Server data source. This means that the representation itself has created the panel and will destroy it when it closes.

◆ ownsPanel() [2/2]

void IlsSwRepresentation::ownsPanel ( IlsBoolean b )

Sets or unsets ownership of the panel to the representation.

When the representation loses ownership, it removes the destroy callback that this representation had previously installed on the panel.

Note: The representation also installs a deletion callback for this panel, which is the static member function CbDestroy().

◆ RepresentationCreatedSymbol()

IlvSymbol * IlsSwRepresentation::RepresentationCreatedSymbol ( )

static

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

This callback is of type IlsSwRepresentationCallbackType.

◆ RepresentationDestroyedSymbol()

IlvSymbol * IlsSwRepresentation::RepresentationDestroyedSymbol ( )

static

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

This callback is of type IlsSwRepresentationCallbackType.

◆ rollbackC2STransaction()

virtual void IlsSwRepresentation::rollbackC2STransaction ( )

virtual

Rolls back a transaction that applies * to a representation.

When asynchronous rollback mode is enabled on the component (see IlsMvComponent::setDefaultC2STransStatus()), this function sends asynchronous requests to the server. In response, the server sends back all the corresponding updates so as to restore the representation to its previous state.
When asynchronous rollback mode is disabled, the transaction is rolled back locally and synchronously. For more information, see Transaction Control in the IlsMvComponent class description. This member function rolls back a transaction that has been previously initialized on the representation.

Reimplemented from IlsRepresentation.

◆ setIconTitle()

virtual void IlsSwRepresentation::setIconTitle ( const IlsString & )

virtual

Called by Rogue Wave Server when the representation attribute iconTitle is notified.

By default, this function sets the icon of the associated panel.

◆ setSelection()

virtual void IlsSwRepresentation::setSelection ( )

virtual

Brings the window or panel associated with the representation to the front.

If the raiseOnSetSelection property is true (which is its default value), this virtual member function brings the window or panel associated with the representation to the front – and deiconifies it if necessary. This function is called whenever the opening of a view is requested for the same view and server object as the current representation. See IlsRepresentation::setSelection() for more information.

Reimplemented from IlsRepresentation.

◆ setTitle()

virtual void IlsSwRepresentation::setTitle ( const IlsString & )

virtual

Called by Rogue Wave Server when the representation attribute title is notified.

By default, this function sets the title of the associated panel.

◆ transferState()

virtual void IlsSwRepresentation::transferState	(	IlsSwRepresentation &	oldRepres,
		IlsBoolean	transferCallbacks = `IlsTrue`
	)

protectedvirtual

Transfers the state of a representation to the representation for which it is called.

If oldRepres has ownership of the panel, ownership is transferred to the new representation.

This function must be called before the end of the first notification cycle for the representation – more precisely in the endS2CUpdate() function defined for a derived class and before calling the function IlsSwRepresentation::endS2CUpdate().

If the parameter transferCallbacks is set to IlsTrue, the callbacks on the current instance are transferred to the new representation.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Closing Representations

Accessors

Other Callbacks

Detailed Description

Constructor & Destructor Documentation

◆ IlsSwRepresentation()

Member Function Documentation

◆ AddCallback() [1/2]

◆ AddCallback() [2/2]

◆ addValidateCallback()

◆ afterInit()

◆ beginC2STransaction()

◆ beginS2CTransaction()

◆ BeginS2CTransactionSymbol()

◆ beginS2CUpdate()

◆ CbDestroy()

◆ CloseRepresentationsInPanel()

◆ commitC2STransaction()

◆ DeclareExecCallback()

◆ deleteRpObject()

◆ endS2CTransaction()

◆ EndS2CTransactionSymbol()

◆ endS2CUpdate()

◆ GadgetContainerInitializedCallbackSymbol()

◆ getPanel()

◆ getServerDataSource()

◆ getTables()

◆ getViewType()

◆ IlvReadCallbackSymbol()

◆ isBad()

◆ IsPropertyDataSource()

◆ onCloseSDS()

◆ onCreation()

◆ onNewRpInSDS()

◆ ownsPanel() [1/2]

◆ ownsPanel() [2/2]

◆ RepresentationCreatedSymbol()

◆ RepresentationDestroyedSymbol()

◆ rollbackC2STransaction()

◆ setIconTitle()

◆ setSelection()

◆ setTitle()

◆ transferState()