org.docgene.model

Interface ImageReference

All Superinterfaces:

ElementReference

All Known Implementing Classes:

XMLExtendedImage, XMLImage, XMLMessageBox

public interface ImageReference
extends ElementReference

Represents an ImageReference.

Method Summary

Modifier and Type	Method and Description
void	bind(org.docgene.model.globals.ImageDefinition image) Bind this image reference to its associated image definition.
default java.io.File	getHRef() Return the image href File.
org.docgene.model.globals.ImageDefinition	getImage() Return the associated image definition.
java.lang.String	getImageID() Return the image reference ID.
java.lang.String	getPackage() Return the image reference package.
default boolean	hasHRef() Return true if this image reference an image path.
default boolean	hasID() Return true if this image reference an image ID.
default boolean	hasImageDefinition() Return true if this image references an image definition
default boolean	hasImageReference() Return true if this image references an image definition or path.

Methods inherited from interface org.docgene.model.ElementReference

getLineNumber, hasLineNumber

Method Detail

bind

void bind(org.docgene.model.globals.ImageDefinition image)

Bind this image reference to its associated image definition.

Parameters:

image - the image definition

getImage

org.docgene.model.globals.ImageDefinition getImage()

Return the associated image definition.

Returns:

the associated image definition

getImageID

java.lang.String getImageID()

Return the image reference ID.

Returns:

the image reference ID

hasID

default boolean hasID()

Return true if this image reference an image ID.

Returns:

true if this image reference an image ID

hasHRef

default boolean hasHRef()

Return true if this image reference an image path.

Returns:

true if this image reference an image path

hasImageDefinition

default boolean hasImageDefinition()

Return true if this image references an image definition

Returns:

true if this image references an image definition

hasImageReference

default boolean hasImageReference()

Return true if this image references an image definition or path.

Returns:

true if this image references an image definition or path

getHRef

default java.io.File getHRef()

Return the image href File.

Returns:

the image href File

getPackage

java.lang.String getPackage()

Return the image reference package.

Returns:

the image reference package