IlsSwServerDataSource Class Reference

This is the class of the Rogue Wave Server data source. More...

#include <ilmvsw/svdataso.h>

Inherits IliDataGem.

Public Member Functions
virtual	~IlsSwServerDataSource ()
	Destructor. More...
virtual void	close (IlsBoolean notify=IlsTrue)
	Closes the representation associated with this Server Data Source, if any. More...
IlsSwRepresentation *	getRepresentation ()
	Returns the instance of the class IlsSwRepresentation or of a derived class that gets created when the view is opened. More...
const IlsString &	getViewName ()
	Retuns the name of the view associated with this data source.
virtual void	onOpenView ()
	Called by the associated instance of the class IlsSwRepresentation when the view is opened. More...

Static Protected Member Functions
static IlvSymbol *	OpenViewCallbackSymbol ()
	Returns the name of the graphical callback OpenViewCallback, which is called when a new view is opened using this Server Data Source. More...

Detailed Description

This is the class of the Rogue Wave Server data source.

Library: mvsw

Instances of this class are associated with a dynamic view type specification that can be edited in Rogue Wave Server Studio. At runtime, the Server data source is created when an .ilv resource file is read, and associated with an instance of the class IlsSwRepresentation or of a derived class when the view is opened.

See also

IlsSwComponent, IlsSwRepresentation.

Constructor & Destructor Documentation

~IlsSwServerDataSource()

virtual IlsSwServerDataSource::~IlsSwServerDataSource ( )

virtual

Destructor.

When the Server Data Source is deleted, the associated representation is closed if it has not been closes before. The function IlsRepresentation::close() is called with the notify argument set to IlsFalse, so that no notification will be performed by the server.

Member Function Documentation

close()

virtual void IlsSwServerDataSource::close ( IlsBoolean  notify = IlsTrue )

virtual

Closes the representation associated with this Server Data Source, if any.

The notify argument specifies whether notification is required when the view is closed. If the notify argument is set to IlsFalse, the virtual member function IlsSwRepresentation::onCloseSDS() is called on the associated representation to delete it.

getRepresentation()

IlsSwRepresentation* IlsSwServerDataSource::getRepresentation

(

)

Returns the instance of the class IlsSwRepresentation or of a derived class that gets created when the view is opened.

Because the view is opened asynchronously, this method returns null until the view is actually opened on component side. See the member function IlsSwComponent::openSwView() for more information.

onOpenView()

virtual void IlsSwServerDataSource::onOpenView ( )

virtual

Called by the associated instance of the class IlsSwRepresentation when the view is opened.

By default, this function calls the graphical callback OpenViewCallback.

OpenViewCallbackSymbol()

static IlvSymbol* IlsSwServerDataSource::OpenViewCallbackSymbol ( )

staticprotected

Returns the name of the graphical callback OpenViewCallback, which is called when a new view is opened using this Server Data Source.

This callback is called just after the callback specified in the methods IlsSwComponent::openSwView().