jsynoptic.plugins.svg
Class SvgShape

java.lang.Object
  simtools.shapes.AbstractShape
      jsynoptic.builtin.Abstract1DShape
          jsynoptic.builtin.Abstract2DShape
              jsynoptic.plugins.svg.SvgShape

All Implemented Interfaces:

java.awt.Shape, java.io.Serializable, java.lang.Cloneable, ContextualActionProvider, Linkable, SelectionContextualActionProvider, AffineTransformData.Listener, DataSourceListener, EndNotificationListener, Resizable, SVGImageFactory.FactoryListener, NamedProperties

public class SvgShape
extends Abstract2DShape
implements SVGImageFactory.FactoryListener

Class .SvgShape svg shape will draw an image (how suprising!) based on a svg file It will use SVGImageFactory to handle images and svg files

See Also:

Serialized Form

Nested Class Summary

static class

SvgShape.SvgShapePropertiesNames

Nested classes/interfaces inherited from class jsynoptic.builtin.Abstract2DShape

Abstract2DShape.Abstract2DShapePropertiesNames

Nested classes/interfaces inherited from class jsynoptic.builtin.Abstract1DShape

Abstract1DShape.Abstract1DShapePropertiesNames

Nested classes/interfaces inherited from class simtools.shapes.AbstractShape

AbstractShape.AbstractShapePropertiesNames

Field Summary

protected boolean	autoFit true : the image should be scaled to fit the shape size, else the shape will be resized
protected java.io.File	defaultFile the source file of the bufferedImage displayed by default This field is nice to have for the user, when changing the image => keep the location
protected boolean	dirtyImage boolean to indicate when the DataSource source has changed
protected java.io.File	dynamicFile the source file of the bufferedImage displayed dynamically (by default or by the SvgMapper)
static SVGImageFactory	factory The factory instance
protected java.awt.image.BufferedImage	image image : reference to the BufferedImage in the ImageHolder Class
protected long	index The index in the data source (used or not)
protected SvgMapper	mapper mapper : SvgMapper to manipulate DataSource source
static java.util.ResourceBundle	resources
static FileSerializer	serializer The file serializer instance
protected DataSource	source

Fields inherited from class jsynoptic.builtin.Abstract2DShape

dirtyFillColor, fillColor, fillDynamicColor, fillMapper, fillMapperIndex, fillMapperSource

Fields inherited from class jsynoptic.builtin.Abstract1DShape

allowResize, bounds2D, delegateEndNotificationListener, dirty, dirtyDrawColor, dirtyRectangle, drawColor, drawDynamicColor, drawMapper, drawMapperIndex, drawMapperSource, fixedRatio, link, MIN_SIZE, ratio, stroke, strokeParams, transform

Fields inherited from class simtools.shapes.AbstractShape

_h, _ox, _oy, _propertyNames, _w, _x, _y, ANTI_ALIASING, currentDialogBox, FONT_NAMES, listeners, REFRESH_PERIOD

Fields inherited from interface jsynoptic.base.ContextualActionProvider

EDITOR_CONTEXT, MOUSE_OUT_CONTEXT, MOUSE_OVER_CONTEXT, MOUSE_PRESSED_CONTEXT, SHAPELIST_CONTEXT, SOURCELIST_CONTEXT

Constructor Summary

SvgShape(int ox, int oy, int width, int height)

Method Summary

protected AbstractShape	cloneShape() Performs a copy of the shape This method has to be overriden to deal with concrete shapes
JPropertiesPanel	createPanel()
void	DataSourceIndexRangeChanged(DataSource ds, long startIndex, long lastIndex) Called when the range of valid index changed
void	DataSourceReplaced(DataSource oldData, DataSource newData) Called when a data source is replaced by another one
void	DataSourceValueChanged(DataSource ds, long minIndex, long maxIndex) Called when at least a value changed in the data source.
void	done(java.awt.image.BufferedImage img) If the loading is successful as well as the painting then the resulting image is provided to the caller
protected void	drawHook(java.awt.Graphics2D g, boolean shapeDrawn) For subclasses, called before restoring original graphics properties, after the delegate shape is drawn if shapeDrawn is true, or after saving the current context, before the delegate shape is drawn if shapeDrawn is false
void	failed(java.lang.String msg) If the loading is not successful or the painting then the error message is provided to the caller
protected java.awt.Shape	getDelegateShape()
protected java.io.File	getDynamicSvgFile()
java.lang.String[]	getPropertyNames() Get the list of property names
java.lang.Object	getPropertyValue(java.lang.String name) Get the value of the property named name
protected java.lang.Object	getSourceValue()
boolean	isAutoFit() If the image should be scaled to fit the shape size (autoFit true), else the shape will be resized
void	notificationEnd(java.lang.Object referer) This callback is called after all notifications were processed.
void	removeListener(ShapeListener sl)
void	resize(int dx, int dy) Resize the component
void	setAutoFit(boolean autoFit) If the image should be scaled to fit the shape size (autoFit true), else the shape will be resized
void	setPropertyValue(java.lang.String name, java.lang.Object value) Assigns value to the property named name
void	wipeOff() Wipe-off all all buffered resources in order to refresh shape.

Methods inherited from class jsynoptic.builtin.Abstract2DShape

createPanel, draw, fillHook, getFillColor, setDelegateEndNotificationListener

Methods inherited from class jsynoptic.builtin.Abstract1DShape

canDoAction, canResize, contains, contains, contains, contains, DataSourceInfoChanged, DataSourceOrderChanged, DataSourceValueRangeChanged, doAction, doCollectiveAction, getActions, getBounds, getBounds2D, getCollectiveActions, getDelegateEndNotificationListener, getDrawColor, getDx, getDy, getLink, getPathIterator, getPathIterator, intersects, intersects, setAnchor, setLink, translate, updateBounds, updateTransform

Methods inherited from class simtools.shapes.AbstractShape

addListener, getAnchor, getInnerProperties, getMax, getMaxTranslated, getMin, notifyChange, notifyChange, refresh, setAnchor, setProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface simtools.data.DataSourceListener

DataSourceInfoChanged, DataSourceOrderChanged, DataSourceValueRangeChanged

Field Detail

resources

public static java.util.ResourceBundle resources

factory

public static SVGImageFactory factory

The factory instance

serializer

public static FileSerializer serializer

The file serializer instance

image

protected transient java.awt.image.BufferedImage image

image : reference to the BufferedImage in the ImageHolder Class

dynamicFile

protected transient java.io.File dynamicFile

the source file of the bufferedImage displayed dynamically (by default or by the SvgMapper)

mapper

protected SvgMapper mapper

mapper : SvgMapper to manipulate DataSource source

source

protected transient DataSource source

index

protected transient long index

The index in the data source (used or not)

dirtyImage

protected transient boolean dirtyImage

boolean to indicate when the DataSource source has changed

defaultFile

protected java.io.File defaultFile

the source file of the bufferedImage displayed by default This field is nice to have for the user, when changing the image => keep the location

autoFit

protected boolean autoFit

true : the image should be scaled to fit the shape size, else the shape will be resized

Constructor Detail

SvgShape

public SvgShape(int ox,
                int oy,
                int width,
                int height)

Parameters:

ox -

oy -

width -

height -

Method Detail

isAutoFit

public boolean isAutoFit()

If the image should be scaled to fit the shape size (autoFit true), else the shape will be resized

setAutoFit

public void setAutoFit(boolean autoFit)

If the image should be scaled to fit the shape size (autoFit true), else the shape will be resized

getDelegateShape

protected java.awt.Shape getDelegateShape()

Specified by:

getDelegateShape in class Abstract1DShape

cloneShape

protected AbstractShape cloneShape()

Description copied from class: Abstract2DShape

Performs a copy of the shape This method has to be overriden to deal with concrete shapes

Overrides:

cloneShape in class Abstract2DShape

Returns:

a copy of the shape

drawHook

protected void drawHook(java.awt.Graphics2D g,
                        boolean shapeDrawn)

Description copied from class: Abstract1DShape

For subclasses, called before restoring original graphics properties, after the delegate shape is drawn if shapeDrawn is true, or after saving the current context, before the delegate shape is drawn if shapeDrawn is false

Overrides:

drawHook in class Abstract1DShape

createPanel

public JPropertiesPanel createPanel()

Overrides:

createPanel in class Abstract1DShape

getSourceValue

protected java.lang.Object getSourceValue()
                                   throws DataException

Returns:

Throws:

DataException

getDynamicSvgFile

protected java.io.File getDynamicSvgFile()

Returns:

a SVG image File that matches with mapped data source value or null if not match found

notificationEnd

public void notificationEnd(java.lang.Object referer)

Description copied from interface: EndNotificationListener

This callback is called after all notifications were processed. The referer object is the one to decide what the end means. For example, it may be a single data source notifying both a range change and a value change. Or it could be a collection notifying all its sources.

Specified by:

notificationEnd in interface EndNotificationListener

Overrides:

notificationEnd in class Abstract2DShape

DataSourceIndexRangeChanged

public void DataSourceIndexRangeChanged(DataSource ds,
                                        long startIndex,
                                        long lastIndex)

Description copied from interface: DataSourceListener

Called when the range of valid index changed

Specified by:

DataSourceIndexRangeChanged in interface DataSourceListener

Overrides:

DataSourceIndexRangeChanged in class Abstract2DShape

Parameters:

ds - The data source that changed

startIndex - The new start Index

lastIndex - The new last index

DataSourceValueChanged

public void DataSourceValueChanged(DataSource ds,
                                   long minIndex,
                                   long maxIndex)

Description copied from interface: DataSourceListener

Called when at least a value changed in the data source. The listener shall then get the values in the given range again, if it is interested by the values in that range.

Specified by:

DataSourceValueChanged in interface DataSourceListener

Overrides:

DataSourceValueChanged in class Abstract2DShape

Parameters:

ds - The data source that changed

minIndex - Lower bound of the range where values changed

maxIndex - Higher bound of the range where values changed

DataSourceReplaced

public void DataSourceReplaced(DataSource oldData,
                               DataSource newData)

Description copied from interface: DataSourceListener

Called when a data source is replaced by another one

Specified by:

DataSourceReplaced in interface DataSourceListener

Overrides:

DataSourceReplaced in class Abstract2DShape

resize

public void resize(int dx,
                   int dy)

Description copied from interface: Resizable

Resize the component

Specified by:

resize in interface Resizable

Overrides:

resize in class Abstract1DShape

Parameters:

dx - value on x axis

dy - value on y axis

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.String name)

Description copied from class: AbstractShape

Get the value of the property named name

Specified by:

getPropertyValue in interface NamedProperties

Overrides:

getPropertyValue in class Abstract2DShape

Parameters:

name - the name of the property to get

Returns:

the property value

See Also:

AbstractShape.getPropertyValue(String)

setPropertyValue

public void setPropertyValue(java.lang.String name,
                             java.lang.Object value)

Description copied from class: AbstractShape

Assigns value to the property named name

Specified by:

setPropertyValue in interface NamedProperties

Overrides:

setPropertyValue in class Abstract2DShape

Parameters:

name - the name of the property to get

value - its new value

See Also:

AbstractShape.setPropertyValue(String, Object)

done

public void done(java.awt.image.BufferedImage img)

Description copied from interface: SVGImageFactory.FactoryListener

If the loading is successful as well as the painting then the resulting image is provided to the caller

Specified by:

done in interface SVGImageFactory.FactoryListener

Parameters:

img - the resulting image

failed

public void failed(java.lang.String msg)

Description copied from interface: SVGImageFactory.FactoryListener

If the loading is not successful or the painting then the error message is provided to the caller

Specified by:

failed in interface SVGImageFactory.FactoryListener

Parameters:

msg - the error message

removeListener

public void removeListener(ShapeListener sl)

Overrides:

removeListener in class AbstractShape

getPropertyNames

public java.lang.String[] getPropertyNames()

Description copied from interface: NamedProperties

Get the list of property names

Specified by:

getPropertyNames in interface NamedProperties

Overrides:

getPropertyNames in class Abstract2DShape

wipeOff

public void wipeOff()

Description copied from class: AbstractShape

Wipe-off all all buffered resources in order to refresh shape. This is overloaded by the various subclasses when necessary. For example, a image shape shall wipe-off all its buffered images

Overrides:

wipeOff in class AbstractShape