idare.imagenode.internal.Layout

Interface ImageNodeLayout

All Superinterfaces:

DataSetAboutToBeChangedListener

All Known Implementing Classes:

AutomaticNodeLayout, ManualLayout, ManualNodeLayout

public interface ImageNodeLayout
extends DataSetAboutToBeChangedListener

Method Summary

Modifier and Type	Method and Description
void	datasetChanged(DataSetChangedEvent e) Inform that there will be a change in the DataSets
void	datasetsChanged(DataSetsChangedEvent e) Inform that a Collection of changes coming up in the DataSets.
void	doLayout() Produce the layout based on the added DataSets.
ColorMap	getColorsForDataSet(DataSetLink ds) Get the ColorMap associated with this DataSet in this AutomaticNodeLayout.
String	getDataSetLabel(DataSetLink ds) Get the label for a specific DataSet used in this layout;
Vector<? extends DataSetLink>	getDatasetsInOrder() Get the DataSets used in this Layout in the order of labeling
boolean	isValid() Check whether this AutomaticNodeLayout is valid.
void	layoutLegendNode(Collection<NodeData> datacollection, org.apache.batik.svggen.SVGGraphics2D svg) Lay out the legend for a specific set of node data
void	layoutNode(Collection<NodeData> datacollection, org.apache.batik.svggen.SVGGraphics2D svg) Layout a specific node in a given context.
boolean	readLayout(DataSetManager dsm, ObjectInputStream os, Object currentobject) Read a layout object from an ObjectInputStream given the last object read (which is the first object of the layout)
void	writeLayout(ObjectOutputStream os) Write all data that is relevant to restore this nodelayout to a ObjectOutputStream

Method Detail

isValid

boolean isValid()

Check whether this AutomaticNodeLayout is valid. A Layout is valid, if its ImageNodeContainer contains at least one DataSet. Thus, by default a newly generated layout is invalid until a DataSet is added.

Returns:

whether this layout is still valid (i.e. has contaniers to lay out)

writeLayout

void writeLayout(ObjectOutputStream os)
          throws IOException

Write all data that is relevant to restore this nodelayout to a ObjectOutputStream

Parameters:

os - The ObjectOutputStream to write the dlayout infromation to

Throws:

IOException - If errors occur with the given stream

readLayout

boolean readLayout(DataSetManager dsm,
                   ObjectInputStream os,
                   Object currentobject)
            throws IOException

Read a layout object from an ObjectInputStream given the last object read (which is the first object of the layout)

Parameters:

dsm - the DataSetManager to get information about DataSets from.

os - The ObjectInputStream to read from

currentobject - The last object read in the ObjectInputStream provided (the first object of the nodelayout save

Returns:

true, if reading was successful, false if there was a non IOException.

Throws:

IOException - If errors occur with the given stream

doLayout

void doLayout()
       throws TooManyItemsException,
              ContainerUnplaceableExcpetion,
              DimensionMismatchException,
              WrongDatasetTypeException

Produce the layout based on the added DataSets.

Throws:

TooManyItemsException - If there are too many Items to layout

ContainerUnplaceableExcpetion - If a container is not placeable

DimensionMismatchException - If the given dimensions don't fit.

WrongDatasetTypeException - IF the given Dataset does not it to the layout

getDataSetLabel

String getDataSetLabel(DataSetLink ds)

Get the label for a specific DataSet used in this layout;

Parameters:

ds - the DataSet to get the label for

Returns:

The String label for the supplied DataSet

getColorsForDataSet

ColorMap getColorsForDataSet(DataSetLink ds)

Get the ColorMap associated with this DataSet in this AutomaticNodeLayout.

Parameters:

ds - - The requested Dataset

Returns:

the ColorMap associated with the DataSet in this AutomaticNodeLayout

getDatasetsInOrder

Vector<? extends DataSetLink> getDatasetsInOrder()

Get the DataSets used in this Layout in the order of labeling

Returns:

A Vector of DataSets in the order they were added during the layout process

layoutNode

void layoutNode(Collection<NodeData> datacollection,
                org.apache.batik.svggen.SVGGraphics2D svg)

Layout a specific node in a given context.

Parameters:

datacollection - The data to be used for drawing

svg - the SVGGraphics2D to draw in

layoutLegendNode

void layoutLegendNode(Collection<NodeData> datacollection,
                      org.apache.batik.svggen.SVGGraphics2D svg)

Lay out the legend for a specific set of node data

Parameters:

datacollection - The data to be used for drawing

svg - the SVGGraphics2D to draw in

datasetChanged

void datasetChanged(DataSetChangedEvent e)

Description copied from interface: DataSetAboutToBeChangedListener

Inform that there will be a change in the DataSets

Specified by:

datasetChanged in interface DataSetAboutToBeChangedListener

Parameters:

e - the DataSetChangedEvent to process

datasetsChanged

void datasetsChanged(DataSetsChangedEvent e)

Description copied from interface: DataSetAboutToBeChangedListener

Inform that a Collection of changes coming up in the DataSets.

Specified by:

datasetsChanged in interface DataSetAboutToBeChangedListener

Parameters:

e - the DataSetChangedEvent to process