Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

service Frame
Description
represents the environment for a desktop component

Frames are the anchors for the office components and they are the components' link to the outside world. They create a skeleton for the whole office api infrastructure by building frame hierarchys. These hierarchies contains all currently loaded documents and make it possible to walk during these trees. A special service Desktop can(!) combine different of such trees to a global one which life time will be controlled by it.

See also
Desktop
Developers Guide
OfficeDev - Creating Frames Manually - Frame Creation
OfficeDev - Frames - Linking Components and Windows

Included Services - Summary
::com::sun::star::xml::UserDefinedAttributesSupplier

contains user defined attributes. (details)

Exported Interfaces - Summary
XFrame

allows the component to be loaded and accessed within the frame; it is the main connection to the environment of the component.

XDispatchProvider

provides access to dispatchers for the frame. (details)

XDispatchInformationProvider

provides information about supported commands (details)

XDispatchProviderInterception

supports interception mechanism for dispatched URLs (details)

XFramesSupplier

provides access to sub frames within this frame

::com::sun::star::task::XStatusIndicatorFactory

supplies access to ::com::sun::star::task::XStatusIndicator objects for the component within the frame to show progresses (details)

Properties' Summary
string
Title
if possible it sets/gets the UI title on/from the frame container window  
XDispatchRecorderSupplier
RecorderSupplier
[ OPTIONAL ]
provides access to the dispatch recorder of the frame  
::com::sun::star::uno::XInterface
LayoutManager
[ OPTIONAL ]
provides access to the LayoutManager of the frame.  
Included Services - Details
::com::sun::star::xml::UserDefinedAttributesSupplier
Usage Restrictions
optional
Description
contains user defined attributes.
See also
::com::sun::star::xml::UserDefinedAttributesSupplier
Exported Interfaces - Details
XFrame
Description
allows the component to be loaded and accessed within the frame; it is the main connection to the environment of the component.
XDispatchProvider
Description
provides access to dispatchers for the frame.

What kind of URLs a frame accepts in the calls to XDispatchProvider::queryDispatch(), and how the returned dispatcher handles dispatches is completely implementation dependent (though of course the restrictions of XDispatchProvider must be met). Frame implementations may (optionally) support special targets in the call to XDispatchProvider::queryDispatch(). Such special targets are passed as target frame name. They may, in addition, require special frame search flags (see FrameSearchFlag), or, in opposite, limit the set of allowed flags.
Common special targets include:

  • _blank
    is used to create a new frame when dispatching the URL.
  • _default
    is used to recycle empty or create a new frame when dispatching the URL.
  • _self
    forces the frame to dispatch the URL into itself. ("" means the same)
  • _parent
    dispatches the URL into the parent frame.
  • _top
    dispatches the URL into the top level frame, the frame where this is invoked belongs to.

See also
XDispatch, XFrame::findFrame()
XDispatchInformationProvider
Usage Restrictions
optional
Description
provides information about supported commands
Since
OOo 2.0
XDispatchProviderInterception
Description
supports interception mechanism for dispatched URLs

Registered objects can intercept, supress or deroute dispatched URLs. If they support another interface too (XInterceptorInfo) it's possible to perform it by directly calling of right interceptor without using list of all registered ones.

XFramesSupplier
Description
provides access to sub frames within this frame
::com::sun::star::task::XStatusIndicatorFactory
Usage Restrictions
optional
Description
supplies access to ::com::sun::star::task::XStatusIndicator objects for the component within the frame to show progresses
Properties' Details
Title
string Title;
Description
if possible it sets/gets the UI title on/from the frame container window

It depends from the type of the frame container window. If it is a system task window all will be OK. Otherwise the title can't be set. Setting/getting of the pure value of this property must be possible in every case. Only showing on the UI can be fail.

RecorderSupplier
XDispatchRecorderSupplier RecorderSupplier;
Usage Restrictions
optional
Description
provides access to the dispatch recorder of the frame

Such recorder can be used to record dispatch requests. The supplier contains a dispatch recorder and provide the functionality to use it for any dispatch object from outside which supports the interface XDispatch. A supplier is available only, if recording was enabled. That means: if somewhere whish to enable recoding on a frame he must set a supplier with a recorder object inside of it. Every user of dispatches has to check then if such supplier is available at this frame property. If value of this property is NULL he must call XDispatch::dispatch() on the original dispatch object. If it's a valid value he must use the supplier by calling his method XDispatchRecorderSupplier::dispatchAndRecord() with the original dispatch object as argument.

Note:
It's not recommended to cache an already getted supplier. Because there exist no possibility to check for enabled/disabled recording then.

Since
OOo 1.1.2
LayoutManager
::com::sun::star::uno::XInterface LayoutManager;
Usage Restrictions
optional
Description
provides access to the LayoutManager of the frame.

 
Top of Page

Apache Software Foundation

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

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