org.docgene.model

Class XMLMessageBox

java.lang.Object

org.docgene.model.AbstractParagraph

org.docgene.model.XMLBlock

org.docgene.model.XMLMessageBox

All Implemented Interfaces:

org.docgene.model.BorderedElement, org.docgene.model.ElementReference, org.docgene.model.ImageReference, ParagraphElement, ParagraphElementParent, org.docgene.model.ReviewElement, StyledElement, org.docgene.model.TodoElement

public class XMLMessageBox
extends XMLBlock
implements org.docgene.model.TodoElement, org.docgene.model.ImageReference

Represent the content of a messageBox tag.

Field Summary

Fields

Modifier and Type	Field and Description
static short	CAPTION_BORDER The type to put the caption on the border of the box.
static short	CAPTION_INSIDE The type to put the caption inside the box.
static short	DEFAULT The default messageBox type.
static short	ERROR The Error messageBox type.
static java.lang.String	IN_WORK_NAME The name of the in work background for the Progress messageBox type.
static short	INFO The Info messageBox type.
static short	PROGRESS The Progress messageBox type.
static short	SUCCESS The Success messageBox type.
static short	WARNING The Warning messageBox type.

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLMessageBox(XMLParentArticle article) Constructor.
XMLMessageBox(XMLParentArticle article, java.io.File href) Constructor.
XMLMessageBox(XMLParentArticle article, java.lang.String id, java.lang.String pack) Constructor.

Method Summary

Modifier and Type	Method and Description
void	bind(org.docgene.model.globals.ImageDefinition image) Bind this imageDef reference to its associated imageDef definition.
void	bindBackgroundImage(org.docgene.model.globals.ImageDefinition image) Bind the optional background imageDef.
XMLParentArticle	getArticle() Return the article in which this message box is used.
org.docgene.model.globals.ImageDefinition	getBackgroundImage() Return the optional background imageDef.
java.lang.String	getCaption() Return the caption of the box (may be null if there is no caption).
short	getCaptionPositionType() Return the type of the positioning for the box caption.
java.lang.String	getColor() Return the message box background color.
java.lang.String	getDeclaration() Return the declaration ID of the element.
java.io.File	getHRef() Return the image path.
org.docgene.model.globals.ImageDefinition	getImage() Return the associated imageDef definition.
java.lang.String	getImageID() Return the imageDef reference ID.
int	getIndex() Return the todo index.
int	getLineNumber() Return the line where the reference appear.
java.lang.String	getPackage() Return the imageDef reference package.
java.lang.String	getReason() Return the reason of the TODO.
java.lang.String	getRef() Return the todo reference composed using the todo index.
short	getType() Return the message box type.
boolean	hasBackgroundImage() Return true if there is a background imageDef.
boolean	hasCaption() Return true if the box has a caption.
boolean	hasHRef() Return true if this messageBox references an imageDef path.
boolean	hasID() Return true if this messageBox references an imageDef ID
boolean	hasImageDefinition() Return true if this message box reference an image definition
boolean	hasImageReference() Return true if this messageBox reference an imageDef definition or path
boolean	hasReason() Return true if the TODO has a reason.
void	setCaption(java.lang.String caption, short captionPosType) Set the message box caption.
void	setColor(java.lang.String color) Set the message box background color.
void	setIndex(int index) Set the todo index.
void	setLineNumber(int lineNumber) Set the line number where the reference appear.
void	setReason(java.lang.String reason) Set the reason of the TODO.
void	setType(short type) Set the message box type.

Methods inherited from class org.docgene.model.XMLBlock

getBorderType, getCustomStyles, hasShadow, setBorderType, setCustomStyles

Methods inherited from class org.docgene.model.AbstractParagraph

addElement, getElements, removeLastElement, setElements

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.TodoElement

getTODOText, hasTODOText

Methods inherited from interface org.docgene.model.ElementReference

hasLineNumber

Methods inherited from interface org.docgene.model.BorderedElement

hasBorder

Methods inherited from interface org.docgene.model.StyledElement

getInlinedStyle, getStyle, hasInlinedStyle, setCustomStyles, setInlinedStyle

Methods inherited from interface org.docgene.model.ParagraphElementParent

countElements, getElement, getFirstElement, getLastElement, hasElements, isEmpty

Field Detail

DEFAULT

public static final short DEFAULT

The default messageBox type.

See Also:

Constant Field Values

INFO

public static final short INFO

The Info messageBox type.

See Also:

Constant Field Values

SUCCESS

public static final short SUCCESS

The Success messageBox type.

See Also:

Constant Field Values

WARNING

public static final short WARNING

The Warning messageBox type.

See Also:

Constant Field Values

ERROR

public static final short ERROR

The Error messageBox type.

See Also:

Constant Field Values

PROGRESS

public static final short PROGRESS

The Progress messageBox type.

See Also:

Constant Field Values

CAPTION_INSIDE

public static final short CAPTION_INSIDE

The type to put the caption inside the box.

See Also:

Constant Field Values

CAPTION_BORDER

public static final short CAPTION_BORDER

The type to put the caption on the border of the box.

See Also:

Constant Field Values

IN_WORK_NAME

public static final java.lang.String IN_WORK_NAME

The name of the in work background for the Progress messageBox type.

See Also:

Constant Field Values

Constructor Detail

XMLMessageBox

public XMLMessageBox(XMLParentArticle article)

Constructor.

Parameters:

article - the article

XMLMessageBox

public XMLMessageBox(XMLParentArticle article,
                     java.lang.String id,
                     java.lang.String pack)

Constructor.

Parameters:

article - the article

id - the imageDef reference id

pack - the imageDef reference package

XMLMessageBox

public XMLMessageBox(XMLParentArticle article,
                     java.io.File href)

Constructor.

Parameters:

article - the article

href - the href File

Method Detail

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

Overrides:

getDeclaration in class XMLBlock

Returns:

the declaration ID of the element

getArticle

public XMLParentArticle getArticle()

Return the article in which this message box is used.

Returns:

the article in which this message box is used

setCaption

public void setCaption(java.lang.String caption,
                       short captionPosType)

Set the message box caption.

Parameters:

caption - the caption

captionPosType - the caption type, specifying where the caption will appear

hasCaption

public boolean hasCaption()

Return true if the box has a caption.

Returns:

true if the box has a caption

getCaption

public java.lang.String getCaption()

Return the caption of the box (may be null if there is no caption).

Returns:

the caption

getCaptionPositionType

public short getCaptionPositionType()

Return the type of the positioning for the box caption.

Returns:

the caption positioning typr

setReason

public void setReason(java.lang.String reason)

Set the reason of the TODO.

Parameters:

reason - the reason

hasReason

public boolean hasReason()

Return true if the TODO has a reason.

Specified by:

hasReason in interface org.docgene.model.TodoElement

Returns:

true if the TODO has a reason

getReason

public java.lang.String getReason()

Return the reason of the TODO.

Specified by:

getReason in interface org.docgene.model.TodoElement

Returns:

the reason of the TODO

setIndex

public void setIndex(int index)

Set the todo index.

Parameters:

index - the todo index

getIndex

public int getIndex()

Return the todo index.

Specified by:

getIndex in interface org.docgene.model.ReviewElement

Returns:

the todo index

getRef

public java.lang.String getRef()

Return the todo reference composed using the todo index.

Specified by:

getRef in interface org.docgene.model.ReviewElement

Returns:

the todo reference

bind

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

Bind this imageDef reference to its associated imageDef definition.

Specified by:

bind in interface org.docgene.model.ImageReference

Parameters:

image - the imageDef definition

getImage

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

Return the associated imageDef definition.

Specified by:

getImage in interface org.docgene.model.ImageReference

Returns:

the associated imageDef definition

hasImageDefinition

public boolean hasImageDefinition()

Return true if this message box reference an image definition

Specified by:

hasImageDefinition in interface org.docgene.model.ImageReference

Returns:

true if this message box reference an image definition

getImageID

public java.lang.String getImageID()

Return the imageDef reference ID.

Specified by:

getImageID in interface org.docgene.model.ImageReference

Returns:

the imageDef reference ID

hasID

public boolean hasID()

Return true if this messageBox references an imageDef ID

Specified by:

hasID in interface org.docgene.model.ImageReference

Returns:

true if this messageBox references an imageDef 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 imageDef path

hasHRef

public boolean hasHRef()

Return true if this messageBox references an imageDef path.

Specified by:

hasHRef in interface org.docgene.model.ImageReference

Returns:

true if this messageBox references an imageDef path

hasImageReference

public boolean hasImageReference()

Return true if this messageBox reference an imageDef definition or path

Specified by:

hasImageReference in interface org.docgene.model.ImageReference

Returns:

true if this messageBox reference an imageDef definition or path.

bindBackgroundImage

public void bindBackgroundImage(org.docgene.model.globals.ImageDefinition image)

Bind the optional background imageDef.

Parameters:

image - the imageDef

getBackgroundImage

public org.docgene.model.globals.ImageDefinition getBackgroundImage()

Return the optional background imageDef.

Returns:

the optional background imageDef

hasBackgroundImage

public boolean hasBackgroundImage()

Return true if there is a background imageDef.

Returns:

true if there is a background imageDef

getPackage

public java.lang.String getPackage()

Return the imageDef reference package.

Specified by:

getPackage in interface org.docgene.model.ImageReference

Returns:

the imageDef reference package

setColor

public void setColor(java.lang.String color)

Set the message box background color.

Parameters:

color - the background color

getColor

public java.lang.String getColor()

Return the message box background color.

Returns:

the background color

setType

public void setType(short type)

Set the message box type.

Parameters:

type - the type

getType

public short getType()

Return the message box type.

Specified by:

getType in interface org.docgene.model.TodoElement

Returns:

the type