:: com :: sun :: star :: form :: runtime ::

interface XFormController
Base Interfaces
XFormController
┣ ::com::sun::star::awt::XTabController
┣ ::com::sun::star::container::XChild
┣ ::com::sun::star::container::XIndexAccess
┃ ┗ ::com::sun::star::container::XElementAccess
┣ ::com::sun::star::container::XEnumerationAccess
┃ ┗ ::com::sun::star::container::XElementAccess
┣ ::com::sun::star::lang::XComponent
┣ ::com::sun::star::util::XModifyBroadcaster
┣ ::com::sun::star::form::XConfirmDeleteBroadcaster
┣ ::com::sun::star::sdb::XSQLErrorBroadcaster
┣ ::com::sun::star::sdb::XRowSetApproveBroadcaster
┣ ::com::sun::star::form::XDatabaseParameterBroadcaster2
┃ ┗ ::com::sun::star::form::XDatabaseParameterBroadcaster
┣ ::com::sun::star::util::XModeSelectorXFilterController

::com::sun::star::awt::XTabController
Description
is used for tab controlling and grouping of the controls.

The model obtained via ::com::sun::star::awt::XTabController::getModel is the form for which the controller is responsible.

::com::sun::star::container::XChild
Description
allows access to the parent controller.
::com::sun::star::container::XIndexAccess
Description
allows access to the sub controllers.
::com::sun::star::container::XEnumerationAccess
Description
allows enumerating sub controllers
::com::sun::star::lang::XComponent
Description
allows life time control of the controller.
::com::sun::star::util::XModifyBroadcaster
Description
allows to register as listener for modifications in the controls which the controller is responsible for.
::com::sun::star::form::XConfirmDeleteBroadcaster
Description
used to notify deletions of data in the form before they happen.

A form controller listens for deletion events at the form it is responsible for. If and only if no ::com::sun::star::form::XConfirmDeleteListener is registered at the controller, it uses an own dialog to ask the user for confirmation.

::com::sun::star::sdb::XSQLErrorBroadcaster
Description
is used to notify errors which happen in the form the controller is responsible for.

A form controller listens for error events at the form it is responsible for. If and only if no ::com::sun::star::sdb::XSQLErrorListener is registered at the controller, it uses an own dialog to notify the user of the error.

::com::sun::star::sdb::XRowSetApproveBroadcaster
Description
is used for multiplexing row set events happening on the form which the controller is responsible for.
::com::sun::star::form::XDatabaseParameterBroadcaster2
Description
is used broadcasting parameter events in the form.

A form controller listens for parameter events at the form it is responsible for. If and only if no ::com::sun::star::form::XDatabaseParameterListener is registered at the controller, it uses an own dialog to ask the user for parameter values.

::com::sun::star::util::XModeSelector
Description
allows switching the form controller to different operation modes.

The two modes usually (but not necessarily) supported by a form controller are the DataMode and the FilterMode, where the former is the usual modus operandi for displaying and modifying data, and the latter is a special mode to enter a filter for the database form which the controller is responsible for.

XFilterController
Usage Restrictions
optional
Description
allows controlling the filter mode.

If the form controller supports a form based filter mode, then it shall also support the XFilterController interface, which allows controlling this mode.


Methods' Summary
addActivateListener adds the specified listener to receive notifications whenever the activation state of the controller changes.  
removeActivateListener removes the specified listener from the list of components to receive notifications whenever the activation state of the controller changes.  
addChildController adds a controller to the list of child controllers  
Attributes' Summary
FormOperations denotes the instance which is used to implement operations on the form which the controller works for.  
CurrentControl provides access to the currently active control  
Context allows to delegate certain tasks to the context of the form controller  
InteractionHandler used (if not NULL) for user interactions triggered by the form controller.  
Methods' Details
addActivateListener
void
addActivateListener( [in] ::com::sun::star::form::XFormControllerListener  _Listener );

Description
adds the specified listener to receive notifications whenever the activation state of the controller changes.
removeActivateListener
void
removeActivateListener( [in] ::com::sun::star::form::XFormControllerListener  _Listener );

Description
removes the specified listener from the list of components to receive notifications whenever the activation state of the controller changes.
addChildController
void
addChildController( [in] XFormController  _ChildController )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
adds a controller to the list of child controllers
Throws
::com::sun::star::lang::IllegalArgumentException if the given controller is NULL, or cannot rightfully be a child controller. Since controllers mirror the hierarchy of the forms the are responsible for, this means that the form of the given child controller must be a child of the controller at which the method is invoked.
Attributes' Details
FormOperations
[ readonly ] XFormOperations FormOperations;
Description
denotes the instance which is used to implement operations on the form which the controller works for.

This instance can be used, for instance, to determine the current state of certain form features.

CurrentControl
[ readonly ] ::com::sun::star::awt::XControl CurrentControl;
Description
provides access to the currently active control
Context
XFormControllerContext Context;
Description
allows to delegate certain tasks to the context of the form controller
InteractionHandler
::com::sun::star::task::XInteractionHandler InteractionHandler;
Description
used (if not NULL) for user interactions triggered by the form controller.
Top of Page