Overview | Module | Use | Devguide | Index

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

:: com :: sun :: star :: frame ::
interface XModel
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-::com::sun::star::lang::XComponent
          |
          +-XModel
Description represents a component which is created from an URL and arguments. It is a representation of a resource in the sense that it was created/loaded from the resource. The arguments are passed to the loader to modify its behavior. An example for such an argument is "AsTemplate", which loads the resource as a template for a new document. (see ::com::sun::star::document::MediaDescriptor for further details) Models can be controlled by controller components, which are usually views of the model. (see Controller for further details) If there is at least one controller, there is by definition a current controller. And if that controller supports the interface ::com::sun::star::view::XSelectionSupplier , it has a current selection too. See also ::com::sun::star::document::MediaDescriptor See also Controller See also ::com::sun::star::view::XSelectionSupplier Developers Guide 6.1.1 Office Development - OpenOffice.org Application Environment - Overview - Framework API - Frame-Controller-Model Paradigm in OpenOffice.org 6.1.3 Office Development - OpenOffice.org Application Environment - Using the Component Framework - Getting Frames, Controllers and Models from Each Other 6.1.3 Office Development - OpenOffice.org Application Environment - Using the Component Framework - Models - XModel 6.1.3 Office Development - OpenOffice.org Application Environment - Using the Component Framework - Models 7.5 Text Documents - Text Document Controller

Methods' Summary
attachResource | informs a model about its resource description.
getURL | provides information about the location of this model
getArgs | provides read acces on currently representation of the ::com::sun::star::document::MediaDescriptor of this model which describes the model and his state
connectController | is called whenever a new controller is created for this model.
disconnectController | is called whenever an existing controller should be deregistered at this model.
lockControllers | suspends some notifications to the controllers which are used for display updates.
unlockControllers | resumes the notifications which were suspended by XModel::lockControllers() .
hasControllersLocked | determines if there is at least one lock remaining.
getCurrentController | provides access to the controller which currently controls this model
setCurrentController | sets a registered controller as the current controller.
getCurrentSelection | provides read access on current selection on controller

Methods' Details
attachResource
boolean attachResource( | [in] string [in] sequence< ::com::sun::star::beans::PropertyValue > | URL, Arguments );
Description informs a model about its resource description. Parameter URL specifies the ressource Parameter Arguments are optional arguments for that ressource (see ::com::sun::star::document::MediaDescriptor ) Returns true for success false otherwise
getURL
string getURL(); |  |
Description provides information about the location of this model Returns the URL of the resource which is represented by this model. See also XStorable::getLocation()
getArgs
sequence< ::com::sun::star::beans::PropertyValue > getArgs(); |  |
Description provides read acces on currently representation of the ::com::sun::star::document::MediaDescriptor of this model which describes the model and his state Returns the arguments with which the model was originally created or stored the last time.
connectController
[oneway] void connectController( | [in] XController | Controller );
Description is called whenever a new controller is created for this model. The ::com::sun::star::lang::XComponent interface of the controller must be used to recognize when it is deleted. Parameter Controller a new controller for this model See also XModel::disconnectController()
disconnectController
[oneway] void disconnectController( | [in] XController | Controller );
Description is called whenever an existing controller should be deregistered at this model. The ::com::sun::star::lang::XComponent interface of the controller must be used to recognize when it is deleted. Parameter Controller the existing controller which should be deregistered See also XModel::connectController()
lockControllers
[oneway] void lockControllers(); |  |
Description suspends some notifications to the controllers which are used for display updates. The calls to XModel::lockControllers() and XModel::unlockControllers() may be nested and even overlapping, but they must be in pairs. While there is at least one lock remaining, some notifications for display updates are not broadcasted.
unlockControllers
[oneway] void unlockControllers(); |  |
Description resumes the notifications which were suspended by XModel::lockControllers() . The calls to XModel::lockControllers() and XModel::unlockControllers() may be nested and even overlapping, but they must be in pairs. While there is at least one lock remaining, some notifications for display updates are not broadcasted.
hasControllersLocked
boolean hasControllersLocked(); |  |
Description determines if there is at least one lock remaining. While there is at least one lock remaining, some notifications for display updates are not broadcasted to the controllers. Returns true if any lock exist false otherwise
getCurrentController
XController getCurrentController(); |  |
Description provides access to the controller which currently controls this model Returns If the controller which is active is a controller of this model, it will be returned. If not, the controller which was the last active of this model is returned. If no controller of this model ever was active, the controller first registered is returned. If no controller is registered for this model, NULL is returned.
setCurrentController
void setCurrentController( | [in] XController raises( | Controller ) ::com::sun::star::container::NoSuchElementException );
Description sets a registered controller as the current controller. Parameter Controller reference to an already existing connected controller, which should be the new active one Throws com::sun::star::container::NoSuchElementException if xController isn't an already connected controller on this model
getCurrentSelection
::com::sun::star::uno::XInterface getCurrentSelection(); |  |
Description provides read access on current selection on controller Returns the current selection in the current controller. If there is no current controller, it returns NULL .

Top of Page

Copyright © 2003 Sun Microsystems, Inc.