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

interface XDataReceiver

Methods' Summary
attachDataProvider attaches a component that provides data for the document.  
setArguments  
getUsedRangeRepresentations returns a list of all range strings for which data has been requested by the most recently attached data provider, and which is still used.  
getUsedData Returns the data requested by the most recently attached data provider, that is still used.  
attachNumberFormatsSupplier attaches an ::XNumberFormatsSupplier to this XDataReceiver.  
getRangeHighlighter Returns a component at which a view representing the data of the attached data provider may listen for highlighting the data ranges used by the currently selected objects in the data receiver component.  
Methods' Details
attachDataProvider
void
attachDataProvider( [in] XDataProvider  xProvider );

Description
attaches a component that provides data for the document.

The previously set data provider will be released.

Parameter xProvider
The new DataProvider. If it is an empty reference, the ChartDocument will have no data.
setArguments
void
setArguments( [in] sequence< ::com::sun::star::beans::PropertyValue >  aArguments )
raises( ::com::sun::star::lang::IllegalArgumentException );

getUsedRangeRepresentations
sequence< string >
getUsedRangeRepresentations();

Description
returns a list of all range strings for which data has been requested by the most recently attached data provider, and which is still used.

This list may be used by the data provider to swap charts out of memory, but still get informed by changes of ranges while the chart is not loaded.

Returns
a list of used range strings.
getUsedData
XDataSource
getUsedData();

Description
Returns the data requested by the most recently attached data provider, that is still used.
attachNumberFormatsSupplier
void
attachNumberFormatsSupplier( [in] ::com::sun::star::util::XNumberFormatsSupplier  xSupplier );

Description
attaches an ::XNumberFormatsSupplier to this XDataReceiver.

The given number formats will be used for display purposes.

getRangeHighlighter
XRangeHighlighter
getRangeHighlighter();

Description
Returns a component at which a view representing the data of the attached data provider may listen for highlighting the data ranges used by the currently selected objects in the data receiver component.

This is typically used by a spreadsheet to hightlight the ranges used by the currently selected object in a chart.

The range hightlighter is optional, i.e., this method may return an empty object.

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.