XMLImage (DocJGenerator Scripting API)

java.lang.Object
- org.docgene.model.AbstractStyledElement
- - org.docgene.model.AbstractJustifiedElement
  - - org.docgene.model.XMLImage

All Implemented Interfaces:

org.docgene.model.Alignment, org.docgene.model.BorderedElement, org.docgene.model.ElementReference, org.docgene.model.ImageHeightType, org.docgene.model.ImageReference, ParagraphElement, StyledElement

Direct Known Subclasses:

XMLExtendedImage
```
public class XMLImage
extends org.docgene.model.AbstractJustifiedElement
implements org.docgene.model.ImageReference, org.docgene.model.BorderedElement, org.docgene.model.ImageHeightType, org.docgene.model.Alignment
```
Represent the reference to an image.

Field Summary
- 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
`XMLImage(org.docgene.model.globals.XMLRootElement element, java.io.File href)` Constructor.
`XMLImage(org.docgene.model.globals.XMLRootElement element, java.lang.String id, java.lang.String pack)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`acceptExtension()` Return true if the image accept an extension (which an be an ImageMap, a reference, or an external link).
`void`	`addArea(org.docgene.model.ImageMap.Area area)` Do nothing.
`void`	`addCategoryReference(XMLCategoryReference catRef)` Do nothing.
`void`	`addExternalLink(XMLExternalLink link)` Do nothing.
`void`	`addReference(XMLReference ref)` Do nothing.
`void`	`bind(org.docgene.model.globals.ImageDefinition image)` Bind this image reference to its associated image definition.
`XMLExtendedImage`	`createExtendedImage()` Creates an extended image from this image.
`char`	`getAlignment()` Return the alignment of the image.
`short`	`getBorderType()` Return the image border type.
`java.lang.String`	`getCaption()` Return the image caption.
`XMLCategoryReference`	`getCategoryReference()` Return the category reference on the image.
`java.awt.Image`	`getConcreteImage()` Return the associated concrete Image.
`java.lang.String`	`getDeclaration()` Return the declaration ID of the element.
`org.docgene.model.globals.XMLRootElement`	`getElement()` Return the element in which this image reference is used.
`short`	`getExtensionType()` Return the extension type.
`XMLExternalLink`	`getExternalLink()` Return the external link on the image.
`int`	`getHeight()` Return the image height.
`char`	`getHeightType()` Return the image height type.
`java.io.File`	`getHRef()` Return the image path.
`org.docgene.model.globals.ImageDefinition`	`getImage()` Return the associated image definition.
`java.awt.Dimension`	`getImageDimension()` Return the underlying image dimension (ie the width and height).
`java.lang.String`	`getImageID()` Return the image reference ID.
`org.docgene.model.ImageMap`	`getImageMap()` Return null.
`java.awt.Dimension`	`getImageReferenceDimension()` Return the underlying image reference dimension (ie the width and height).
`java.io.File`	`getInputFile()` Return the input File for the image.
`java.net.URL`	`getInputURL()` Return the input URL for the image.
`int`	`getLineNumber()` Return the line where the reference appear.
`char`	`getMargin()` Return the associated Image margin.
`java.lang.String`	`getPackage()` Return the image reference package.
`XMLReference`	`getReference()` Return the reference on the image.
`char`	`getVerticalAlignment()` Return the vertical alignment of the image.
`int`	`getWidth()` Return the image width.
`boolean`	`hasBorder()` Return true if the image has a border.
`boolean`	`hasCaption()` Return true if the image has a caption.
`boolean`	`hasConcreteImage()` Return true if the image definition has an associated concrete image.
`boolean`	`hasHeight()` Return true if the image has a specified height.
`boolean`	`hasHRef()` Return true if this image reference an image path.
`boolean`	`hasID()` Return true if this image reference an mageDef ID
`boolean`	`hasImageDefinition()` Return true if this image references an image definition
`boolean`	`hasImageMap()` Return false.
`boolean`	`hasImageReference()` Return true if this image reference an image definition or path
`boolean`	`hasShadow()` Return true if the image has a shadowed border.
`boolean`	`hasSize()` Return true if the image has a specified size.
`boolean`	`hasWidth()` Return true if the image has a specified width.
`boolean`	`isExtendedImage()` Return true if the image is an extended image.
`boolean`	`isFloat()` Return true if the image element should have the "float" attribute.
`boolean`	`isRelativeHeight()` Return true if the image height is relative (in %).
`boolean`	`isRelativeWidth()` Return true if the image width is relative (in %).
`boolean`	`isUsingMaximumSize()` Return true if the image must not have a size greater than the image definition size.
`void`	`setAbsoluteWidth(int width)` Set the image absolute width.
`void`	`setAlignment(char align)` Set the alignment of the image.
`void`	`setBorderType(short borderType)` Set if the image border type.
`void`	`setCaption(java.lang.String caption)` Set the image caption.
`void`	`setFirstInLine(boolean isFirstInLine)` Set if the image is the first element in its line.
`void`	`setFloat(boolean isFloat)` Set if the image element should have the "float" attribute.
`void`	`setHeight(int height, boolean relHeight)` Set the image height.
`void`	`setHeightAsText()` Set the image height as the same height as the text.
`void`	`setID(java.lang.String id)` Set the image ID.
`void`	`setLineNumber(int lineNumber)` Set the line number where the reference appear.
`void`	`setMargin(char margin)` Set the image margin.
`void`	`setRelativeWidth(int width)` Set the image relative width.
`void`	`setVerticalAlignment(char valign)` Set the vertical alignment of the image.
`void`	`setWidth(int width, boolean relWidth)` Set the image width.
`void`	`useMaximumSize(boolean useMaxSize)` Set if the image must not have a size greater than the image definition size.
`boolean`	`useTextHeight()` Return true if the image height has the same height as the text.

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

- Constructor Detail
  - XMLImage
```
public XMLImage(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
  - XMLImage
```
public XMLImage(org.docgene.model.globals.XMLRootElement element,
                java.io.File href)
```
    Constructor.
    
    Parameters:
    
    element - the element which use the image
    
    href - the image file
- Method Detail
  - isExtendedImage
```
public boolean isExtendedImage()
```
    Return true if the image is an extended image.
    
    Returns:
    
    false
  - createExtendedImage
```
public XMLExtendedImage createExtendedImage()
```
    Creates an extended image from this image.
    
    Returns:
    
    the extended image
  - setFirstInLine
```
public void setFirstInLine(boolean isFirstInLine)
```
    Set if the image is the first element in its line.
    
    Overrides:
    
    setFirstInLine in class org.docgene.model.AbstractJustifiedElement
    
    Parameters:
    
    isFirstInLine - true if the element is the first element in its line
  - setLineNumber
```
public void setLineNumber(int lineNumber)
```
    Set the line number where the reference appear.
    
    Parameters:
    
    lineNumber - the line number
  - getLineNumber
```
public int getLineNumber()
```
    Return the line where the reference appear.
    
    Specified by:
    
    getLineNumber in interface org.docgene.model.ElementReference
    
    Returns:
    
    the line number
  - getDeclaration
```
public java.lang.String getDeclaration()
```
    Return the declaration ID of the element.
    
    Specified by:
    
    getDeclaration in interface StyledElement
    
    Returns:
    
    the declaration ID of the element
  - getElement
```
public org.docgene.model.globals.XMLRootElement getElement()
```
    Return the element in which this image reference is used.
    
    Returns:
    
    the element in which this image reference is used
  - setFloat
```
public void setFloat(boolean isFloat)
```
    Set if the image element should have the "float" attribute.
    
    Parameters:
    
    isFloat - true if the image element should have the "float" attribute
  - isFloat
```
public boolean isFloat()
```
    Return true if the image element should have the "float" attribute.
    
    Returns:
    
    true if the image element should have the "float" attribute
  - addReference
```
public void addReference(XMLReference ref)
```
    Do nothing.
    
    Parameters:
    
    ref - the reference
  - addCategoryReference
```
public void addCategoryReference(XMLCategoryReference catRef)
```
    Do nothing.
    
    Parameters:
    
    catRef - the category reference
  - addExternalLink
```
public void addExternalLink(XMLExternalLink link)
```
    Do nothing.
    
    Parameters:
    
    link - the external link
  - addArea
```
public void addArea(org.docgene.model.ImageMap.Area area)
```
    Do nothing.
    
    Parameters:
    
    area - the area
  - hasImageMap
```
public boolean hasImageMap()
```
    Return false.
    
    Returns:
    
    false
  - acceptExtension
```
public boolean acceptExtension()
```
    Return true if the image accept an extension (which an be an ImageMap, a reference, or an external link).
    
    Returns:
    
    true
  - getExtensionType
```
public short getExtensionType()
```
    Return the extension type.
    
    Returns:
    
    -1
  - getImageMap
```
public org.docgene.model.ImageMap getImageMap()
```
    Return null.
    
    Returns:
    
    null
  - getReference
```
public XMLReference getReference()
```
    Return the reference on the image.
    
    Returns:
    
    null
  - getCategoryReference
```
public XMLCategoryReference getCategoryReference()
```
    Return the category reference on the image.
    
    Returns:
    
    null
  - getExternalLink
```
public XMLExternalLink getExternalLink()
```
    Return the external link on the image.
    
    Returns:
    
    null
  - setBorderType
```
public void setBorderType(short borderType)
```
    Set if the image border type.
    
    Parameters:
    
    borderType - the image border type
    
    See Also:
    
    BorderType
  - getBorderType
```
public short getBorderType()
```
    Return the image border type.
    
    Specified by:
    
    getBorderType in interface org.docgene.model.BorderedElement
    
    Returns:
    
    the image border type
    
    See Also:
    
    BorderType
  - setMargin
```
public void setMargin(char margin)
```
    Set the image margin.
    
    Parameters:
    
    margin - the image margin
  - getMargin
```
public char getMargin()
```
    Return the associated Image margin.
    
    Returns:
    
    the associated Image margin
  - hasShadow
```
public boolean hasShadow()
```
    Return true if the image has a shadowed border.
    
    Specified by:
    
    hasShadow in interface org.docgene.model.BorderedElement
    
    Returns:
    
    true if the image has a shadowed border
  - hasBorder
```
public boolean hasBorder()
```
    Return true if the image has a border.
    
    Specified by:
    
    hasBorder in interface org.docgene.model.BorderedElement
    
    Returns:
    
    true if the image has a border
  - setAlignment
```
public void setAlignment(char align)
```
    Set the alignment of the image.
    
    Specified by:
    
    setAlignment in interface org.docgene.model.Alignment
    
    Parameters:
    
    align - the alignment
    
    See Also:
    
    Alignment
  - getAlignment
```
public char getAlignment()
```
    Return the alignment of the image.
    
    Specified by:
    
    getAlignment in interface org.docgene.model.Alignment
    
    Returns:
    
    the alignment
    
    See Also:
    
    Alignment
  - setVerticalAlignment
```
public void setVerticalAlignment(char valign)
```
    Set the vertical alignment of the image.
    
    Parameters:
    
    valign - the alignment
    
    See Also:
    
    VerticalAlignment
  - getVerticalAlignment
```
public char getVerticalAlignment()
```
    Return the vertical alignment of the image.
    
    Returns:
    
    the vertical alignment
    
    See Also:
    
    VerticalAlignment
  - useMaximumSize
```
public void useMaximumSize(boolean useMaxSize)
```
    Set if the image must not have a size greater than the image definition size.
    
    Parameters:
    
    useMaxSize - true if the image must not have a size greater than the image definition size
  - isUsingMaximumSize
```
public boolean isUsingMaximumSize()
```
    Return true if the image must not have a size greater than the image definition size.
    
    Returns:
    
    true if the image must not have a size greater than the image definition size
  - setAbsoluteWidth
```
public void setAbsoluteWidth(int width)
```
    Set the image absolute width.
    
    Parameters:
    
    width - the image width
  - setRelativeWidth
```
public void setRelativeWidth(int width)
```
    Set the image relative width.
    
    Parameters:
    
    width - the image width
  - setWidth
```
public void setWidth(int width,
                     boolean relWidth)
```
    Set the image width.
    
    Parameters:
    
    width - the image width
    
    relWidth - true if the width is relative (in percent)
  - isRelativeWidth
```
public boolean isRelativeWidth()
```
    Return true if the image width is relative (in %).
    
    Returns:
    
    true if the image width is relative
  - setHeight
```
public void setHeight(int height,
                      boolean relHeight)
```
    Set the image height.
    
    Parameters:
    
    height - the image height
    
    relHeight - true if the height is relative (in percent)
  - setHeightAsText
```
public void setHeightAsText()
```
    Set the image height as the same height as the text.
  - useTextHeight
```
public boolean useTextHeight()
```
    Return true if the image height has the same height as the text.
    
    Returns:
    
    true if the image height has the same height as the text
  - getHeightType
```
public char getHeightType()
```
    Return the image height type.
    
    Returns:
    
    the image height type
  - isRelativeHeight
```
public boolean isRelativeHeight()
```
    Return true if the image height is relative (in %).
    
    Returns:
    
    true if the image height is relative
  - setCaption
```
public void setCaption(java.lang.String caption)
```
    Set the image caption.
    
    Parameters:
    
    caption - the image caption
  - getCaption
```
public java.lang.String getCaption()
```
    Return the image caption.
    
    Returns:
    
    the image caption
  - hasCaption
```
public boolean hasCaption()
```
    Return true if the image has a caption.
    
    Returns:
    
    true if the image has a caption
  - setID
```
public void setID(java.lang.String id)
```
    Set the image ID.
    
    Parameters:
    
    id - the image ID
  - bind
```
public void bind(org.docgene.model.globals.ImageDefinition image)
```
    Bind this image reference to its associated image definition.
    
    Specified by:
    
    bind in interface org.docgene.model.ImageReference
    
    Parameters:
    
    image - the image definition
  - getImage
```
public org.docgene.model.globals.ImageDefinition getImage()
```
    Return the associated image definition.
    
    Specified by:
    
    getImage in interface org.docgene.model.ImageReference
    
    Returns:
    
    the associated image definition
  - hasImageDefinition
```
public boolean hasImageDefinition()
```
    Return true if this image references an image definition
    
    Specified by:
    
    hasImageDefinition in interface org.docgene.model.ImageReference
    
    Returns:
    
    true if this image references an image definition
  - getInputURL
```
public java.net.URL getInputURL()
```
    Return the input URL for the image.
    
    Returns:
    
    the input File
  - getInputFile
```
public java.io.File getInputFile()
```
    Return the input File for the image.
    
    Returns:
    
    the input File
  - getImageID
```
public java.lang.String getImageID()
```
    Return the image reference ID.
    
    Specified by:
    
    getImageID in interface org.docgene.model.ImageReference
    
    Returns:
    
    the image reference ID
  - hasID
```
public boolean hasID()
```
    Return true if this image reference an mageDef ID
    
    Specified by:
    
    hasID in interface org.docgene.model.ImageReference
    
    Returns:
    
    true if this image reference an mageDef ID
  - getHRef
```
public java.io.File getHRef()
```
    Return the image path. Note that it is only the name of the image file, excluding the roots of the file.
    
    Specified by:
    
    getHRef in interface org.docgene.model.ImageReference
    
    Returns:
    
    the image path
  - hasHRef
```
public boolean hasHRef()
```
    Return true if this image reference an image path.
    
    Specified by:
    
    hasHRef in interface org.docgene.model.ImageReference
    
    Returns:
    
    true if this image reference an image path
  - hasImageReference
```
public boolean hasImageReference()
```
    Return true if this image reference an image definition or path
    
    Specified by:
    
    hasImageReference in interface org.docgene.model.ImageReference
    
    Returns:
    
    true if this image reference an image definition or path.
  - hasConcreteImage
```
public boolean hasConcreteImage()
```
    Return true if the image definition has an associated concrete image.
    
    Returns:
    
    true if the image definition has an associated concrete image
  - getConcreteImage
```
public java.awt.Image getConcreteImage()
```
    Return the associated concrete Image.
    
    Returns:
    
    the associated concrete Image
  - getImageReferenceDimension
```
public java.awt.Dimension getImageReferenceDimension()
```
    Return the underlying image reference dimension (ie the width and height).
    
    Returns:
    
    the dimension
  - getImageDimension
```
public java.awt.Dimension getImageDimension()
```
    Return the underlying image dimension (ie the width and height).
    
    Returns:
    
    the dimension
  - getPackage
```
public java.lang.String getPackage()
```
    Return the image reference package.
    
    Specified by:
    
    getPackage in interface org.docgene.model.ImageReference
    
    Returns:
    
    the image reference package
  - getWidth
```
public int getWidth()
```
    Return the image width.
    
    Returns:
    
    the image width
  - getHeight
```
public int getHeight()
```
    Return the image height.
    
    Returns:
    
    the image height
  - hasSize
```
public boolean hasSize()
```
    Return true if the image has a specified size.
    
    Returns:
    
    true if the image has a specified size
  - hasWidth
```
public boolean hasWidth()
```
    Return true if the image has a specified width.
    
    Returns:
    
    true if the image has a specified width
  - hasHeight
```
public boolean hasHeight()
```
    Return true if the image has a specified height.
    
    Returns:
    
    true if the image has a specified height

Class XMLImage

Field Summary

Fields inherited from interface org.docgene.model.ImageHeightType

Fields inherited from interface org.docgene.model.Alignment

Fields inherited from interface org.docgene.model.StyledElement

Constructor Summary

Method Summary

Methods inherited from class org.docgene.model.AbstractJustifiedElement

Methods inherited from class org.docgene.model.AbstractStyledElement

Methods inherited from class java.lang.Object

Methods inherited from interface org.docgene.model.ElementReference

Methods inherited from interface org.docgene.model.StyledElement

Constructor Detail

XMLImage

XMLImage

Method Detail

isExtendedImage

createExtendedImage

setFirstInLine

setLineNumber

getLineNumber

getDeclaration

getElement

setFloat

isFloat

addReference

addCategoryReference

addExternalLink

addArea

hasImageMap

acceptExtension

getExtensionType

getImageMap

getReference

getCategoryReference

getExternalLink

setBorderType

getBorderType

setMargin

getMargin

hasShadow

hasBorder

setAlignment

getAlignment

setVerticalAlignment

getVerticalAlignment

useMaximumSize

isUsingMaximumSize

setAbsoluteWidth

setRelativeWidth

setWidth

isRelativeWidth

setHeight

setHeightAsText

useTextHeight

getHeightType

isRelativeHeight

setCaption

getCaption

hasCaption

setID

bind

getImage

hasImageDefinition

getInputURL

getInputFile

getImageID

hasID

getHRef

hasHRef

hasImageReference

hasConcreteImage

getConcreteImage

getImageReferenceDimension

getImageDimension

getPackage

getWidth

getHeight

hasSize

hasWidth