Overview | Module | Use | Devguide | Index

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

:: com :: sun :: star :: frame ::
interface XController
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-::com::sun::star::lang::XComponent
          |
          +-XController
Description With this interface, components viewed in a Frame can serve events (by supplying dispatches). See also XFrame See also ::com::sun::star::awt::XWindow See also XModel Developers Guide 6.1.1 Office Development - OpenOffice.org Application Environment - Overview - Framework API - Frame-Controller-Model Paradigm in OpenOffice.org 6.1.1 Office Development - OpenOffice.org Application Environment - Overview - Framework API - Controllers 6.1.3 Office Development - OpenOffice.org Application Environment - Using the Component Framework - Getting Frames, Controllers and Models from Each Other

Methods' Summary
attachFrame | is called to attach the controller with its managing frame.
attachModel | is called to attach the controller to a new model.
suspend | is called to prepare the controller for closing the view
getViewData | provides access to current view status
restoreViewData | restores the view status using the data gotten from a previous call to XController::getViewData() .
getModel | provides access to currently attached model
getFrame | provides access to owner frame of this controller

Methods' Details
attachFrame
void attachFrame( | [in] XFrame | Frame );
Description is called to attach the controller with its managing frame. Parameter Frame the new owner frame of this controller
attachModel
boolean attachModel( | [in] XModel | Model );
Description is called to attach the controller to a new model. Parameter Model the new model for this controller Returns true if attach was successfully false otherwise
suspend
boolean suspend( | [in] boolean | Suspend );
Description is called to prepare the controller for closing the view Parameter Suspend true force the controller to suspend his work false try to reactivate the controller Returns true if request was accepted and of course successfully finished false otherwise
getViewData
any getViewData(); |  |
Description provides access to current view status Returns set of data that can be used to restore the current view status at later time by using XController::restoreViewData()
restoreViewData
void restoreViewData( | [in] any | Data );
Description restores the view status using the data gotten from a previous call to XController::getViewData() . Parameter Data set of data to restore it
getModel
XModel getModel(); |  |
Description provides access to currently attached model Returns the currently attached model.
getFrame
XFrame getFrame(); |  |
Description provides access to owner frame of this controller Returns the frame containing this controller.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.