Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

:: com :: sun :: star :: frame ::

interface XController
Base Interfaces
XController
┗ ::com::sun::star::lang::XComponent
::com::sun::star::lang::XComponent
(referenced interface's summary:)
allows to exclicitly free resources and break cyclic references.
Description
With this interface, components viewed in a Frame can serve events (by supplying dispatches).
See also
XFrame, ::com::sun::star::awt::XWindow, XModel
Developers Guide
OfficeDev - Component - Getting Frames, Controllers and Models from Each Other
OfficeDev - Controllers
OfficeDev - Frame-Controller-Model Paradigm in Apache OpenOffice
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
trueif attach was successfully
falseotherwise
suspend
boolean
suspend( [in] boolean  Suspend );
Description
is called to prepare the controller for closing the view
Parameter Suspend
trueforce the controller to suspend his work falsetry to reactivate the controller
Returns
trueif request was accepted and of course successfully finished
falseotherwise
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 © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.