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 ::

interface XRecordableDispatch
Description
extends an existing XDispatch implementation with functionality for dispatch recording

This interface can be implemented as an additional one beside an existing XDispatch one to provide record functionality of dispatches. Because it's an additional interface the status events are available there and not at this interface.

But normaly this interface mustn't be used directly. If a dispatch object is well known and recording was enabled on a XDispatchRecorderSupplier it's possible to use method XDispatchRecorderSupplier::dispatchAndRecord() of it to make dispatch and recording automaticly. The interface XRecordableDispatch is used transparently there.

Example
 XDispatch xDispatcher = xFrame.queryDispatch(aURL,"",0);
 XRecordableDispatch xRecordable = (XRecordableDispatch)UnoRuntime.queryInterface(
   XRecordableDispatch.class,
   xDispatcher);

 xDispatcher.addStatusListener(this,aURL);

 if (xRecordable!=null)
   xRecordable.dispatchAndRecord(aURL,lArguments,xRecorder);
 else
   xDispatcher.dispatch(aURL,lArguments);
 ...
 xDispatcher.removeStatusListener(this,aURL);
 
Since
OOo 1.1.2
See also
XDispatchRecorderSupplier, XDispatch

Methods' Summary
dispatchAndRecord dispatch and record it  
Methods' Details
dispatchAndRecord
[oneway] void
dispatchAndRecord( [in] ::com::sun::star::util::URL  URL,
[in] sequence< ::com::sun::star::beans::PropertyValue >  Arguments,
[in] XDispatchRecorder  Recorder );

Description
dispatch and record it
Parameter URL
full parsed URL wich describe the feature which should be dispatched (executed)
Parameter Arguments
optional arguments for this request (see ::com::sun::star::document::MediaDescriptor for details)
Parameter Recorder
object which can be used to record the request (available on XDispatchRecorderSupplier::getDispatchRecorder())
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.