Difference between revisions of "Documentation/DevGuide/OfficeDev/Controllers"

From Apache OpenOffice Wiki
Jump to: navigation, search
m
m (FINAL VERSION FOR L10N)
(One intermediate revision by one other user not shown)
Line 6: Line 6:
 
|NextPage=Documentation/DevGuide/OfficeDev/Windows
 
|NextPage=Documentation/DevGuide/OfficeDev/Windows
 
}}
 
}}
{{DISPLAYTITLE:Controllers}}
+
{{Documentation/DevGuideLanguages|Documentation/DevGuide/OfficeDev/{{SUBPAGENAME}}}}
 +
{{DISPLAYTITLE:Controllers}}
 
<!--<idltopic>com.sun.star.frame.Controller;com.sun.star.frame.XController</idltopic>-->
 
<!--<idltopic>com.sun.star.frame.Controller;com.sun.star.frame.XController</idltopic>-->
 
Controllers in {{PRODUCTNAME}} are between a frame and document model. This is their basic role as expressed in <idl>com.sun.star.frame.XController</idl>, which has methods <code>getModel()</code> and <code>getFrame()</code>. The method <code>getFrame()</code> provides the frame that the controller is attached to. The method <code>getModel()</code> returns a document model, but it may return an empty reference if the component does not have a model.
 
Controllers in {{PRODUCTNAME}} are between a frame and document model. This is their basic role as expressed in <idl>com.sun.star.frame.XController</idl>, which has methods <code>getModel()</code> and <code>getFrame()</code>. The method <code>getFrame()</code> provides the frame that the controller is attached to. The method <code>getModel()</code> returns a document model, but it may return an empty reference if the component does not have a model.
Line 14: Line 15:
 
[[Image:FCMController.png|none|thumb|400px|Controller with Model and Frame]]
 
[[Image:FCMController.png|none|thumb|400px|Controller with Model and Frame]]
  
There can be more than one controller instance with frames of their own controlling the same document model simultaneously. Multiple controllers and frames are created by {{PRODUCTNAME}} when the user clicks '''Window - New Window'''.
+
A single document model can be controlled simultaneously by several controller instances, each associated with a separate frame. Multiple controllers and frames are created by {{PRODUCTNAME}} when the user clicks '''Window - New Window'''.
  
 
{{PDL1}}
 
{{PDL1}}
  
 
[[Category:Documentation/Developer's Guide/Office Development]]
 
[[Category:Documentation/Developer's Guide/Office Development]]

Revision as of 11:13, 13 May 2009



Controllers in OpenOffice.org are between a frame and document model. This is their basic role as expressed in com.sun.star.frame.XController, which has methods getModel() and getFrame(). The method getFrame() provides the frame that the controller is attached to. The method getModel() returns a document model, but it may return an empty reference if the component does not have a model.

Usually the controller objects support additional interfaces specific to the document type they control, such as com.sun.star.sheet.XSpreadsheetView for Calc document controllers or com.sun.star.text.XTextViewCursorSupplier for Writer document controllers.

Controller with Model and Frame

A single document model can be controlled simultaneously by several controller instances, each associated with a separate frame. Multiple controllers and frames are created by OpenOffice.org when the user clicks Window - New Window.

Content on this page is licensed under the Public Documentation License (PDL).
Personal tools
In other languages