Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: form ::
interface XFormController
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-::com::sun::star::awt::XTabController
          |
          +-XFormController
Description provides functionality to control the activation of forms controls. There is a duality of forms ( ::com::sun::star::form::component::DataForm ) and form controllers. In a document view, for every loaded form there is a form controller which is responsible for exactly the controls which's models are direct children of the form. In some sense, a form controller is the view representation of a form, like a form control is the view representation of a form control model . This is also reflected in this interface: If you call XTabController::getModel on a form controller, the form which the controller is responsible for will be returned. As always in the model-view-paradigm, there is no way from a model to its controller, mostly, because for one given form, there is one controller for every view of the document. A controller is called active if one of the controls it is responsible for has the focus, else inactive. To be notified whenever this activation state of a given controller changes, you can add listeners. See also ::com::sun::star::form::component::Form

Methods' Summary
getCurrentControl | access to the currently active control
addActivateListener | adds the specified listener to receive notifications whenever the activation state of the controller changes.
removeActivateListener | removes the specified listener

Methods' Details
getCurrentControl
::com::sun::star::awt::XControl getCurrentControl(); |  |
Description access to the currently active control Returns the currently active control, or NULL if there is no such control
addActivateListener
[oneway] void addActivateListener( | [in] XFormControllerListener | l );
Description adds the specified listener to receive notifications whenever the activation state of the controller changes. Parameter l the listener to add.
removeActivateListener
[oneway] void removeActivateListener( | [in] XFormControllerListener | l );
Description removes the specified listener Parameter l the listener to remove.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.