ilog.views.svg

Interface SVGGraphicFactory

All Known Implementing Classes:

SVGDefaultGraphicFactory

public interface SVGGraphicFactory

This factory is in charge of the creation of the graphic objects for the SVG reader. It also retrieves or creates manager layers as needed, and adds the graphic objects to the appropriate bag.

By default, the SVG reader uses the default implementation SVGDefaultGraphicFactory.

The main purpose of this interface is to allow the creation of subclasses of the default graphic object classes or manager layer class.

Since:

JViews 8.1

See Also:

SVGDocumentReader, SVGDocumentReaderConfigurator.setGraphicFactory(ilog.views.svg.SVGGraphicFactory)

Method Summary

Modifier and Type	Method and Description
void	addObject(IlvGraphic obj, IlvGraphicBag bag) Adds a graphic object to a given graphic bag.
void	addObject(IlvGraphic obj, IlvManager manager, int layerIndex) Adds a graphic object to a given layer of a manager.
IlvGeneralPath	createGeneralPath() Creates a general path graphic object.
IlvGraphicSet	createGraphicSet() Creates a graphic set object.
IlvIcon	createIcon(String location, IlvRect rect) Creates an icon graphic object.
IlvIcon	createIcon(URL url, IlvRect rect) Creates an icon object.
IlvText	createText(IlvPoint position, String text) Creates a text graphic object.
IlvTextPath	createTextPath(Shape shape, String text) Creates a text path graphic object.
IlvZoomableLabel	createZoomableLabel(IlvPoint position, String label) Creates a zoomable label graphic object.
IlvManagerLayer	findFreeLayer(IlvManager manager) Finds a new free manager layer.

Method Detail

addObject

void addObject(IlvGraphic obj,
               IlvManager manager,
               int layerIndex)

Adds a graphic object to a given layer of a manager.

The SVG reader calls this method if the content of the SVG file is read into an IlvManager or a subclass. Otherwise, if the reading is done in another type of IlvGraphicBag, for instance in an IlvGraphicSet, the reader calls the method addObject(IlvGraphic, IlvGraphicBag).

Parameters:

obj - The graphic object to be added to the manager.

manager - The manager into which the content of the SVG file is read.

layerIndex - The index of the manager layer where the object must be added.

addObject

void addObject(IlvGraphic obj,
               IlvGraphicBag bag)

Adds a graphic object to a given graphic bag.

The SVG reader calls this method if the content of the SVG file is read into a IlvGraphicBag which is not an IlvManager or a subclass, for instance an IlvGraphicSet. Otherwise, if the reading is done in an IlvManager or a subclass, the reader calls the method addObject(IlvGraphic, IlvManager, int).

Parameters:

obj - The graphic object to be added to the bag.

bag - The bag where the graphic object must be added.

findFreeLayer

IlvManagerLayer findFreeLayer(IlvManager manager)

Finds a new free manager layer.

Note the following:

• The method is called once for each layer described by the SVG file, in the order they occur in the SVG file.
• In order to add to the manager the objects that belong to a given layer, the reader passes as layerIndex argument of the method addObject(IlvGraphic, IlvManager, int) the index of the layer (see IlvManagerLayer.getIndex()) returned by the method prepareLayer for the corresponding layer.

Parameters:

manager - The manager into which the content of the SVG file is read.

Returns:

The layer of the manager.

createGeneralPath

IlvGeneralPath createGeneralPath()

Creates a general path graphic object.

createGraphicSet

IlvGraphicSet createGraphicSet()

Creates a graphic set object.

createIcon

IlvIcon createIcon(URL url,
                   IlvRect rect)

Creates an icon object.

Parameters:

url - The URL of the bitmap image.

rect - The definition rectangle of the object.

createIcon

IlvIcon createIcon(String location,
                   IlvRect rect)

Creates an icon graphic object.

Parameters:

location - The location of the bitmap image. This is in particular used when the location is "data: ..."

rect - The definition rectangle of the object.

Since:

JViews 8.5

createTextPath

IlvTextPath createTextPath(Shape shape,
                           String text)

Creates a text path graphic object.

Parameters:

shape - The baseline of the text path.

text - The text.

createZoomableLabel

IlvZoomableLabel createZoomableLabel(IlvPoint position,
                                     String label)

Creates a zoomable label graphic object.

Parameters:

position - The position of the label object.

label - The text of the label.

createText

IlvText createText(IlvPoint position,
                   String text)

Creates a text graphic object.

Parameters:

position - The position of the text object.

text - The text.