org.docgene.model

Class XMLExtendedImage

java.lang.Object

org.docgene.model.AbstractStyledElement

org.docgene.model.AbstractJustifiedElement

org.docgene.model.XMLImage

org.docgene.model.XMLExtendedImage

All Implemented Interfaces:

Alignment, BorderedElement, ElementReference, ImageHeightType, ImageReference, ParagraphElement, StyledElement

public class XMLExtendedImage
extends XMLImage

Represent the reference to an image which has a link to an areaRef, a ref, or a link.

Field Summary

Fields

Modifier and Type	Field and Description
static short	CATEGORY_REFERENCE Tags a category reference extended image.
static short	EXTERNAL_LINK Tags an external link extended image.
static short	IMAGE_MAP Tags an image Map extended image.
static short	REFERENCE Tags a reference extended image.

Fields inherited from interface org.docgene.model.ImageHeightType

HEIGHT_ABSOLUTE, HEIGHT_RELATIVE, HEIGHT_TEXT

Fields inherited from interface org.docgene.model.Alignment

CENTER, LEFT, RIGHT

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLExtendedImage(org.docgene.model.globals.XMLRootElement element, java.io.File href) Constructor.
XMLExtendedImage(org.docgene.model.globals.XMLRootElement element, java.lang.String id, java.lang.String pack) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	acceptExtension() Return true if the image accept an extension (whichc an be an ImageMap, a reference, or an external link).
void	addArea(ImageMap.Area area) Add an active area in the image.
void	addCategoryReference(XMLCategoryReference catRef) Add a category reference on the image.
void	addExternalLink(XMLExternalLink link) Add an external link on the image.
void	addReference(XMLReference ref) Add a reference on the image.
XMLExtendedImage	createExtendedImage() Return this extended image.
XMLCategoryReference	getCategoryReference() Return the category reference on the image.
short	getExtensionType() Return the extension type.
XMLExternalLink	getExternalLink() Return the external link on the image.
ImageMap	getImageMap() Return the image image Map (can be null).
XMLReference	getReference() Return the reference on the image.
boolean	hasExtensionType() Return true if an extension type is defined on this image.
boolean	hasImageMap() Return true if the image has an image Map.
boolean	isExtendedImage() Return true if the image is an extended image.

Methods inherited from class org.docgene.model.XMLImage

bind, getAlignment, getBorderType, getCaption, getConcreteImage, getDeclaration, getElement, getHeight, getHeightType, getHRef, getImage, getImageDimension, getImageID, getImageReferenceDimension, getInputFile, getInputURL, getLineNumber, getMargin, getPackage, getVerticalAlignment, getWidth, hasBorder, hasCaption, hasConcreteImage, hasHeight, hasHRef, hasID, hasImageDefinition, hasImageReference, hasShadow, hasSize, hasWidth, isFloat, isRelativeHeight, isRelativeWidth, isUsingMaximumSize, setAbsoluteWidth, setAlignment, setBorderType, setCaption, setFirstInLine, setFloat, setHeight, setHeightAsText, setID, setLineNumber, setMargin, setRelativeWidth, setVerticalAlignment, setWidth, useMaximumSize, useTextHeight

Methods inherited from class org.docgene.model.AbstractJustifiedElement

isFirstInLine

Methods inherited from class org.docgene.model.AbstractStyledElement

getCustomStyles, getInlinedStyle, setCustomStyles, setInlinedStyle

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.docgene.model.ElementReference

hasLineNumber

Methods inherited from interface org.docgene.model.StyledElement

getStyle, hasInlinedStyle, setCustomStyles

Field Detail

IMAGE_MAP

public static final short IMAGE_MAP

Tags an image Map extended image.

See Also:

Constant Field Values

REFERENCE

public static final short REFERENCE

Tags a reference extended image.

See Also:

Constant Field Values

CATEGORY_REFERENCE

public static final short CATEGORY_REFERENCE

Tags a category reference extended image.

See Also:

Constant Field Values

EXTERNAL_LINK

public static final short EXTERNAL_LINK

Tags an external link extended image.

See Also:

Constant Field Values

Constructor Detail

XMLExtendedImage

public XMLExtendedImage(org.docgene.model.globals.XMLRootElement element,
                        java.lang.String id,
                        java.lang.String pack)

Constructor.

Parameters:

element - the element which use the image

id - the image reference ID

pack - the package

XMLExtendedImage

public XMLExtendedImage(org.docgene.model.globals.XMLRootElement element,
                        java.io.File href)

Constructor.

Parameters:

element - the element which use the image

href - the href File

Method Detail

isExtendedImage

public boolean isExtendedImage()

Return true if the image is an extended image.

Overrides:

isExtendedImage in class XMLImage

Returns:

true

createExtendedImage

public XMLExtendedImage createExtendedImage()

Return this extended image.

Overrides:

createExtendedImage in class XMLImage

Returns:

this

addArea

public void addArea(ImageMap.Area area)

Add an active area in the image.

Overrides:

addArea in class XMLImage

Parameters:

area - the area

addReference

public void addReference(XMLReference ref)

Add a reference on the image.

Overrides:

addReference in class XMLImage

Parameters:

ref - the reference

addCategoryReference

public void addCategoryReference(XMLCategoryReference catRef)

Add a category reference on the image.

Overrides:

addCategoryReference in class XMLImage

Parameters:

catRef - the category reference

addExternalLink

public void addExternalLink(XMLExternalLink link)

Add an external link on the image.

Overrides:

addExternalLink in class XMLImage

Parameters:

link - the external link

acceptExtension

public boolean acceptExtension()

Return true if the image accept an extension (whichc an be an ImageMap, a reference, or an external link).

Overrides:

acceptExtension in class XMLImage

Returns:

false

hasExtensionType

public boolean hasExtensionType()

Return true if an extension type is defined on this image.

Returns:

true if an extension type is defined on this image

getExtensionType

public short getExtensionType()

Return the extension type. It can be:

• IMAGE_MAP for an Image map
• REFERENCE for a reference
• CATEGORY_REFERENCE for a category reference
• EXTERNAL_LINK for an external link

Overrides:

getExtensionType in class XMLImage

Returns:

the extension type

hasImageMap

public boolean hasImageMap()

Return true if the image has an image Map.

Overrides:

hasImageMap in class XMLImage

Returns:

true if the image has an image Map

getImageMap

public ImageMap getImageMap()

Return the image image Map (can be null).

Overrides:

getImageMap in class XMLImage

Returns:

the image image Map (can be null)

getReference

public XMLReference getReference()

Return the reference on the image.

Overrides:

getReference in class XMLImage

Returns:

the reference

getCategoryReference

public XMLCategoryReference getCategoryReference()

Return the category reference on the image.

Overrides:

getCategoryReference in class XMLImage

Returns:

the category reference

getExternalLink

public XMLExternalLink getExternalLink()

Return the external link on the image.

Overrides:

getExternalLink in class XMLImage

Returns:

the external link