org.eclipse.birt.chart.ui.swt.interfaces
Interface IUIManager

public interface IUIManager

Author:

Actuate Corporation

Method Summary

boolean	addCollectionInstance(java.lang.String sCollection) Add a single instance of all the sheets defined in the specified collection.
Chart	getCurrentModelState() Returns a COPY of the current model state.
java.lang.String[]	getRegisteredCollectionValue(java.lang.String sCollection) Get the node names present in the specified collection.
boolean	registerSheetCollection(java.lang.String sCollection, java.lang.String[] saNodePaths) Register a collection of Sheets (denoted by their Node Paths) that can be operated on together.
boolean	removeCollectionInstance(java.lang.String sCollection) Remove the last instance of each sheet defined in the specified collection.

Method Detail

registerSheetCollection

public boolean registerSheetCollection(java.lang.String sCollection,
                                       java.lang.String[] saNodePaths)

Register a collection of Sheets (denoted by their Node Paths) that can be operated on together.

Parameters:

sCollection - unique name for the collection

saNodePaths - array of node paths associated with each sheet entry in the collection

Returns:

the result of the registration. Will be false if collection is already defined.

getRegisteredCollectionValue

public java.lang.String[] getRegisteredCollectionValue(java.lang.String sCollection)

Get the node names present in the specified collection.

Parameters:

sCollection - name of the collection whose contents are to be fetched

Returns:

array of node paths present in the registered collection. null if collection is not found

addCollectionInstance

public boolean addCollectionInstance(java.lang.String sCollection)

Add a single instance of all the sheets defined in the specified collection.

Parameters:

sCollection - name of collection whose components are to be added

Returns:

true if addition of all the nodes succeeds. false if any component was not found or if addition of any node fails

removeCollectionInstance

public boolean removeCollectionInstance(java.lang.String sCollection)

Remove the last instance of each sheet defined in the specified collection.

Parameters:

sCollection - name of collection whose components are to be removed

Returns:

true if removal of all nodes was successful. false if any component was not found or any component could not be removed

getCurrentModelState

public Chart getCurrentModelState()

Returns a COPY of the current model state. Changes made in this model will not be reflected in the 'actual' model of the chart

Returns:

copy of the current chart model with the editor