Package ro.sync.ecss.extensions.dita

Class DITAUpdateImageMapOperation

java.lang.Object

ro.sync.ecss.extensions.commons.imagemap.operations.UpdateImageMapOperationBase

ro.sync.ecss.extensions.dita.DITAUpdateImageMapOperation

All Implemented Interfaces:

AuthorOperation, Extension

@API(type=INTERNAL,
     src=PUBLIC)
public class DITAUpdateImageMapOperation
extends UpdateImageMapOperationBase

DITA implementation of the operation that updates an image map with shape information from an SVG.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DITAUpdateImageMapOperation.DITANewShapeDescriptor	Descriptor of a shape that was added client-side.

Field Summary

Fields inherited from class ro.sync.ecss.extensions.commons.imagemap.operations.UpdateImageMapOperationBase

ARGUMENT_SHAPES, ARGUMENTS

Fields inherited from interface ro.sync.ecss.extensions.api.AuthorOperation

NAMESPACE_ARGUMENT, NAMESPACE_ARGUMENT_DESCRIPTOR, SCHEMA_AWARE_ARGUMENT, SCHEMA_AWARE_ARGUMENT_DESCRIPTOR

Constructor Summary

Constructors

Constructor	Description
DITAUpdateImageMapOperation()

Method Summary

Modifier and Type	Method	Description
protected AuthorElement[]	getExistingShapesList(AuthorElement existingImageMap)	Return the list of existing shapes starting from the existing Image Map.
protected AuthorElement	getImageMapElement(AuthorElement currentElement)	Return the image map that contains the current element.
protected List<? extends NewShapeDescriptor>	getNewShapesList(String svgText)	Return the list of new shapes descriptors.

Methods inherited from class ro.sync.ecss.extensions.commons.imagemap.operations.UpdateImageMapOperationBase

doOperation, getArguments, getDescription

Methods inherited from class java.lang.Object

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

Constructor Details

DITAUpdateImageMapOperation

public DITAUpdateImageMapOperation()

Method Details

getNewShapesList

protected List<? extends NewShapeDescriptor> getNewShapesList(String svgText)
                                                       throws AuthorOperationException

Description copied from class: UpdateImageMapOperationBase

Return the list of new shapes descriptors.

Specified by:

getNewShapesList in class UpdateImageMapOperationBase

Parameters:

svgText - The SVG text.

Returns:

The list.

Throws:

AuthorOperationException - If the conversion fails.

See Also:

• UpdateImageMapOperationBase.getNewShapesList(java.lang.String)

getExistingShapesList

protected AuthorElement[] getExistingShapesList(AuthorElement existingImageMap)

Description copied from class: UpdateImageMapOperationBase

Return the list of existing shapes starting from the existing Image Map.

Specified by:

getExistingShapesList in class UpdateImageMapOperationBase

Parameters:

existingImageMap - The existing Image Map.

Returns:

The array of elements that correspond to shapes.

See Also:

• UpdateImageMapOperationBase.getExistingShapesList(ro.sync.ecss.extensions.api.node.AuthorElement)

getImageMapElement

protected AuthorElement getImageMapElement(AuthorElement currentElement)

Description copied from class: UpdateImageMapOperationBase

Return the image map that contains the current element.

Specified by:

getImageMapElement in class UpdateImageMapOperationBase

Parameters:

currentElement - The current element.

Returns:

The image map element.

See Also:

• UpdateImageMapOperationBase.getImageMapElement(ro.sync.ecss.extensions.api.node.AuthorElement)