org.vectomatic.svg.edit.client.engine

Class SVGModel

java.lang.Object

org.vectomatic.svg.edit.client.engine.SVGModel

All Implemented Interfaces:

com.google.gwt.event.dom.client.MouseDownHandler, com.google.gwt.event.dom.client.MouseMoveHandler, com.google.gwt.event.dom.client.MouseUpHandler, com.google.gwt.event.shared.EventHandler, com.google.gwt.event.shared.HasHandlers, HasRotationHandlers, HasScalingHandlers

public class SVGModel
extends Object
implements com.google.gwt.event.dom.client.MouseDownHandler, com.google.gwt.event.dom.client.MouseMoveHandler, com.google.gwt.event.dom.client.MouseUpHandler, HasScalingHandlers, HasRotationHandlers

Model class for an SVG document edited by the application. The document has the following DOM structure:

elementGroup

Contains all the elements from the original SVG, id-normalized.

twinGroup

Contains a visibility-hidden clone of the previous group. It is used to display the selection and implement highlighting.

gridGroup

Contains all the helper elements required to display grids, rulers...

geometryGroup

Used to applied opacity for highlighting operations

Author:

laaglu

Field Summary

Fields

Modifier and Type	Field and Description
protected float	angle The current scaling the xform group and twin group
protected CommandStore	commandStore The Store which contains this model commands
protected Map<org.vectomatic.dom.svg.impl.SVGElement,SVGElementModel>	elementToModel Associates SVG elements with their model wrapper
static String	EXT_TWIN Id Prefix extension for twins
protected Grid	grid The grid settings for this model
protected SVGElementModel	highlightedModel The highlighted model in highlighting mode
protected boolean	highlightingMode The current mode (false = display mode, true = highlighting mode)
protected String	idPrefix The prefix used for all id attributes in this model
protected Map<String,Object>	idToModel Associates element ids with their model
protected org.vectomatic.dom.svg.OMSVGMatrix	m The matrix transform to the xform group and twin group
protected SVGElementModel	modelGroup The root of the model tree.
protected float	scale The current rotation of the xform group and twin group
protected SVGSelectionModel	selectionModel The selection model
protected com.extjs.gxt.ui.client.store.TreeStore<SVGElementModel>	store The Store which contains this model data
protected org.vectomatic.dom.svg.OMSVGSVGElement	svg The root of the SVG document
protected static Map<String,MetaModel<org.vectomatic.dom.svg.impl.SVGElement>>	tagNameToMetamodel
protected Map<String,Integer>	tagNameToTagCount A map used to generate node names for nodes which do not have a title element.
protected SVGViewBoxElementModel	viewBox The svg rect use to represent the viewBox
protected org.vectomatic.dom.svg.OMSVGRect	windowRect A rectangled defining the bounds of the GXT viewport
protected org.vectomatic.dom.svg.OMSVGGElement	xformGroup A group used to apply a visualization transform change the display of the document.

Constructor Summary

Constructors

Constructor and Description
SVGModel()

Method Summary

Modifier and Type	Method and Description
void	add(SVGElementModel parentModel, SVGElementModel model) Appends a model to the children of the specified model
com.google.gwt.event.shared.HandlerRegistration	addRotationHandler(RotationHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addScalingHandler(ScalingHandler handler)
protected void	adopt(SVGElementModel model)
protected void	adopt(SVGElementModel model, boolean root)
SVGElementModel	clone(SVGElementModel model, String name) Recursively clones the specified model.
boolean	contains(org.vectomatic.dom.svg.impl.SVGElement element) Return true if the specified SVG element is part of this model
SVGElementModel	convert(org.vectomatic.dom.svg.impl.SVGElement element) Generates a model around an overlay type node
SVGElementModel	create(com.google.gwt.dom.client.Node modelNode, com.google.gwt.dom.client.Node modelTwin)
org.vectomatic.dom.svg.OMSVGElement	dereference(String idref)
void	displayTwin(SVGElementModel model, boolean value)
void	fireEvent(com.google.gwt.event.shared.GwtEvent<?> event)
String	generateName(SVGElementModel model)
CommandStore	getCommandStore() Returns the CommandStore which contains this model commands
org.vectomatic.dom.svg.OMSVGPoint	getCoordinates(com.google.gwt.event.dom.client.MouseEvent<? extends com.google.gwt.event.shared.EventHandler> e, boolean snap) Returns the coordinates of a mouse event, converted to the coordinate system of the model
org.vectomatic.dom.svg.OMSVGGElement	getElementGroup()
Grid	getGrid() Returns this document grid
String	getIdPrefix() Returns the document id prefix.
String	getMarkup()
static MetaModel<org.vectomatic.dom.svg.impl.SVGElement>	getMetamodel(org.vectomatic.dom.svg.impl.SVGElement element)
SVGElementModel	getRoot() Returns the root node of this model
float	getRotation()
float	getScale() Returns the scaling of the SVG.
com.extjs.gxt.ui.client.widget.treepanel.TreePanelSelectionModel<SVGElementModel>	getSelectionModel() Returns the selection model.
com.extjs.gxt.ui.client.store.TreeStore<SVGElementModel>	getStore() Returns the Store which contains this model data
org.vectomatic.dom.svg.OMSVGSVGElement	getSvgElement()
org.vectomatic.dom.svg.OMSVGGElement	getTwinGroup()
static float	getVertexSize(org.vectomatic.dom.svg.itf.ISVGLocatable element)
static float	getVertexSize(SVGElementModel model) Computes the size of the vertex representation (it should be 1mm whatever the scaling factor).
SVGViewBoxElementModel	getViewBox() Returns the model viewBox.
org.vectomatic.dom.svg.OMSVGRect	getWindowRect()
void	highlightModel(SVGElementModel model)
void	insertBefore(SVGElementModel parentModel, SVGElementModel newModel, SVGElementModel refModel) Insert a new model into this SVG model before the specified child model or the specified parent model.
boolean	isHighlightingMode()
static SVGModel	newInstance(org.vectomatic.dom.svg.OMSVGSVGElement svg, String title, String idPrefix) Factory method.
void	onAttach()
void	onKeyPress(com.extjs.gxt.ui.client.event.ComponentEvent event)
void	onKeyUp(com.extjs.gxt.ui.client.event.ComponentEvent event)
void	onMouseDown(com.google.gwt.event.dom.client.MouseDownEvent event)
void	onMouseMove(com.google.gwt.event.dom.client.MouseMoveEvent event)
void	onMouseUp(com.google.gwt.event.dom.client.MouseUpEvent event)
protected void	orphan(SVGElementModel model)
protected void	orphan(SVGElementModel model, boolean root)
void	remove(SVGElementModel model) Removes the specified model
void	setHighlightingMode(boolean highlightingMode)
void	setRotation(float angle) Sets the rotation of the SVG.
void	setScale(float scale) Sets the scaling of the SVG.
void	setSvgElement(org.vectomatic.dom.svg.OMSVGSVGElement svg, String title, String idPrefix) Binds this SVG model to the specified SVG 'svg' element
void	setWindowRect(int width, int height) Specifies the dimensions of the window viewport
protected void	storeUpdate(com.extjs.gxt.ui.client.store.StoreEvent<SVGElementModel> se)
void	updateContextMenu(com.extjs.gxt.ui.client.widget.menu.Menu contextMenu) Updates the context menu based on the model selection
void	updateTransform() Updates the display group transform and changes the CSS size of the SVG accordingly

Methods inherited from class java.lang.Object

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

Field Detail

EXT_TWIN

public static final String EXT_TWIN

Id Prefix extension for twins

See Also:

Constant Field Values

idPrefix

protected String idPrefix

The prefix used for all id attributes in this model

svg

protected org.vectomatic.dom.svg.OMSVGSVGElement svg

The root of the SVG document

xformGroup

protected org.vectomatic.dom.svg.OMSVGGElement xformGroup

A group used to apply a visualization transform change the display of the document.

modelGroup

protected SVGElementModel modelGroup

The root of the model tree.

m

protected org.vectomatic.dom.svg.OMSVGMatrix m

The matrix transform to the xform group and twin group

angle

protected float angle

The current scaling the xform group and twin group

scale

protected float scale

The current rotation of the xform group and twin group

selectionModel

protected SVGSelectionModel selectionModel

The selection model

highlightingMode

protected boolean highlightingMode

The current mode (false = display mode, true = highlighting mode)

highlightedModel

protected SVGElementModel highlightedModel

The highlighted model in highlighting mode

tagNameToTagCount

protected Map<String,Integer> tagNameToTagCount

A map used to generate node names for nodes which do not have a title element.

store

protected com.extjs.gxt.ui.client.store.TreeStore<SVGElementModel> store

The Store which contains this model data

commandStore

protected CommandStore commandStore

The Store which contains this model commands

elementToModel

protected Map<org.vectomatic.dom.svg.impl.SVGElement,SVGElementModel> elementToModel

Associates SVG elements with their model wrapper

idToModel

protected Map<String,Object> idToModel

Associates element ids with their model

viewBox

protected SVGViewBoxElementModel viewBox

The svg rect use to represent the viewBox

windowRect

protected org.vectomatic.dom.svg.OMSVGRect windowRect

A rectangled defining the bounds of the GXT viewport

grid

protected Grid grid

The grid settings for this model

tagNameToMetamodel

protected static Map<String,MetaModel<org.vectomatic.dom.svg.impl.SVGElement>> tagNameToMetamodel

Constructor Detail

SVGModel

public SVGModel()

Method Detail

newInstance

public static SVGModel newInstance(org.vectomatic.dom.svg.OMSVGSVGElement svg,
                                   String title,
                                   String idPrefix)

Factory method. Creates a new SVG model from the supplied SVG root and title

Parameters:

svg - The svg root

title - The svg title

idPrefix - the id prefix for this model

Returns:

The new SVG document

getMetamodel

public static MetaModel<org.vectomatic.dom.svg.impl.SVGElement> getMetamodel(org.vectomatic.dom.svg.impl.SVGElement element)

convert

public SVGElementModel convert(org.vectomatic.dom.svg.impl.SVGElement element)

Generates a model around an overlay type node

Type Parameters:

T - the node type

Parameters:

element - The overlay type node

Returns:

The node model

getSvgElement

public org.vectomatic.dom.svg.OMSVGSVGElement getSvgElement()

setSvgElement

public void setSvgElement(org.vectomatic.dom.svg.OMSVGSVGElement svg,
                          String title,
                          String idPrefix)

Binds this SVG model to the specified SVG 'svg' element

Parameters:

svg - an SVG 'svg' element

title - the name of the root element

idPrefix - the id prefix for this model

contains

public boolean contains(org.vectomatic.dom.svg.impl.SVGElement element)

Return true if the specified SVG element is part of this model

Parameters:

element - the element to test

Returns:

true if the specified SVG element is part of this model

adopt

protected void adopt(SVGElementModel model)

adopt

protected void adopt(SVGElementModel model,
                     boolean root)

orphan

protected void orphan(SVGElementModel model)

orphan

protected void orphan(SVGElementModel model,
                      boolean root)

create

public SVGElementModel create(com.google.gwt.dom.client.Node modelNode,
                              com.google.gwt.dom.client.Node modelTwin)

add

public void add(SVGElementModel parentModel,
                SVGElementModel model)

Appends a model to the children of the specified model

Parameters:

parentModel - The parent model

model - The model to append

insertBefore

public void insertBefore(SVGElementModel parentModel,
                         SVGElementModel newModel,
                         SVGElementModel refModel)

Insert a new model into this SVG model before the specified child model or the specified parent model.

Parameters:

parentModel - The parent model

newModel - The model to insert. If the model is not in this SVG model, it is removed from its previous SVG model before being inserted into this SVG model.

refModel - The reference model. If null, the new model is appended to the children of the parent model

remove

public void remove(SVGElementModel model)

Removes the specified model

Parameters:

model -

clone

public SVGElementModel clone(SVGElementModel model,
                             String name)

Recursively clones the specified model.

Parameters:

model -

Returns:

the root of the cloned tree

storeUpdate

protected void storeUpdate(com.extjs.gxt.ui.client.store.StoreEvent<SVGElementModel> se)

getMarkup

public String getMarkup()

getRoot

public SVGElementModel getRoot()

Returns the root node of this model

Returns:

getStore

public com.extjs.gxt.ui.client.store.TreeStore<SVGElementModel> getStore()

Returns the Store which contains this model data

Returns:

getCommandStore

public CommandStore getCommandStore()

Returns the CommandStore which contains this model commands

Returns:

getSelectionModel

public com.extjs.gxt.ui.client.widget.treepanel.TreePanelSelectionModel<SVGElementModel> getSelectionModel()

Returns the selection model.

Returns:

the selection model.

getViewBox

public SVGViewBoxElementModel getViewBox()

Returns the model viewBox.

Returns:

the model viewBox.

getIdPrefix

public String getIdPrefix()

Returns the document id prefix.

Returns:

the document id prefix.

onMouseMove

public void onMouseMove(com.google.gwt.event.dom.client.MouseMoveEvent event)

Specified by:

onMouseMove in interface com.google.gwt.event.dom.client.MouseMoveHandler

onMouseDown

public void onMouseDown(com.google.gwt.event.dom.client.MouseDownEvent event)

Specified by:

onMouseDown in interface com.google.gwt.event.dom.client.MouseDownHandler

onMouseUp

public void onMouseUp(com.google.gwt.event.dom.client.MouseUpEvent event)

Specified by:

onMouseUp in interface com.google.gwt.event.dom.client.MouseUpHandler

onKeyPress

public void onKeyPress(com.extjs.gxt.ui.client.event.ComponentEvent event)

onKeyUp

public void onKeyUp(com.extjs.gxt.ui.client.event.ComponentEvent event)

updateContextMenu

public void updateContextMenu(com.extjs.gxt.ui.client.widget.menu.Menu contextMenu)

Updates the context menu based on the model selection

Parameters:

contextMenu - The context menu to update

getCoordinates

public org.vectomatic.dom.svg.OMSVGPoint getCoordinates(com.google.gwt.event.dom.client.MouseEvent<? extends com.google.gwt.event.shared.EventHandler> e,
                                                        boolean snap)

Returns the coordinates of a mouse event, converted to the coordinate system of the model

Parameters:

e - A mouse event

snap - True if the coordinate should be snapped to the grid when grid snapping is activated

Returns:

The coordinates of the mouse event, converted to the coordinate system of the specified matrix

onAttach

public void onAttach()

getScale

public float getScale()

Returns the scaling of the SVG.

Returns:

The scale (1 means scale 1:1, 2 means scale 2:1)

setScale

public void setScale(float scale)

Sets the scaling of the SVG.

Parameters:

scale - The scale (1 means scale 1:1, 2 means scale 2:1)

getRotation

public float getRotation()

setRotation

public void setRotation(float angle)

Sets the rotation of the SVG.

Parameters:

angle - The angle (in degrees)

getGrid

public Grid getGrid()

Returns this document grid

Returns:

fireEvent

public void fireEvent(com.google.gwt.event.shared.GwtEvent<?> event)

Specified by:

fireEvent in interface com.google.gwt.event.shared.HasHandlers

addRotationHandler

public com.google.gwt.event.shared.HandlerRegistration addRotationHandler(RotationHandler handler)

Specified by:

addRotationHandler in interface HasRotationHandlers

addScalingHandler

public com.google.gwt.event.shared.HandlerRegistration addScalingHandler(ScalingHandler handler)

Specified by:

addScalingHandler in interface HasScalingHandlers

setWindowRect

public void setWindowRect(int width,
                          int height)

Specifies the dimensions of the window viewport

Parameters:

width - width of the window viewport

height - height of the window viewport

getWindowRect

public org.vectomatic.dom.svg.OMSVGRect getWindowRect()

updateTransform

public void updateTransform()

Updates the display group transform and changes the CSS size of the SVG accordingly

getVertexSize

public static float getVertexSize(SVGElementModel model)

Computes the size of the vertex representation (it should be 1mm whatever the scaling factor).

Returns:

getVertexSize

public static float getVertexSize(org.vectomatic.dom.svg.itf.ISVGLocatable element)

getElementGroup

public org.vectomatic.dom.svg.OMSVGGElement getElementGroup()

getTwinGroup

public org.vectomatic.dom.svg.OMSVGGElement getTwinGroup()

isHighlightingMode

public boolean isHighlightingMode()

setHighlightingMode

public void setHighlightingMode(boolean highlightingMode)

highlightModel

public void highlightModel(SVGElementModel model)

displayTwin

public void displayTwin(SVGElementModel model,
                        boolean value)

generateName

public String generateName(SVGElementModel model)

dereference

public org.vectomatic.dom.svg.OMSVGElement dereference(String idref)