org.docgene.model

Class XMLInfobox

java.lang.Object

org.docgene.model.XMLInfobox

All Implemented Interfaces:

ParagraphElementParent, StyledElement

public class XMLInfobox
extends java.lang.Object
implements ParagraphElementParent, StyledElement

Represent an infobox implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	XMLInfobox.BaseProperty An infobox property.
class	XMLInfobox.EnumProperty An infobox enum property.
class	XMLInfobox.Property An infobox property.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_NAME The key for the name property.

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLInfobox(java.lang.String id, java.lang.String pack) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addElement(ParagraphElement element) Add an element.
XMLInfobox.EnumProperty	addEnumProperty(java.lang.String key, java.lang.String state) Create an enum property of a specified key and adds it to the infobox.
XMLInfobox.BaseProperty	addProperty(java.lang.String key) Create a property of a specified key and adds it to the infobox.
void	bind(org.docgene.model.globals.InfoboxDefinition infoboxDef) Bind the infobox to its associated definition.
int	countProperties() Return the number of properties, including the default.
java.lang.String	getCaption() Return the infobox caption.
org.docgene.model.globals.InfoboxDefinition	getDefinition() Return the infobox associated definition.
java.util.List<ParagraphElement>	getElements() Return the list of children elements.
java.lang.String	getID() Return the infobox ID.
java.lang.String	getPackage() Return the infobox reference package.
java.util.Map<java.lang.String,XMLInfobox.Property>	getProperties() Return the infobox properties.
XMLInfobox.Property	getProperty(java.lang.String key) Return the property of a specified key.
boolean	hasCaption() Return true if the infobox has a caption.
boolean	hasProperty(java.lang.String key) Return true if the infobox has a property of a specified key.
void	setElements(java.util.List<ParagraphElement> elements) Set the list of elements.

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

countElements, getElement, getFirstElement, getLastElement, hasElements, isEmpty

Methods inherited from interface org.docgene.model.StyledElement

getCustomStyles, getDeclaration, getInlinedStyle, getStyle, hasInlinedStyle, setCustomStyles, setCustomStyles, setInlinedStyle

Field Detail

PROPERTY_NAME

public static final java.lang.String PROPERTY_NAME

The key for the name property.

See Also:

Constant Field Values

Constructor Detail

XMLInfobox

public XMLInfobox(java.lang.String id,
                  java.lang.String pack)

Constructor.

Parameters:

id - the infobox ID

pack - the package

Method Detail

getID

public java.lang.String getID()

Return the infobox ID.

Returns:

the ID

getPackage

public java.lang.String getPackage()

Return the infobox reference package.

Returns:

the infobox reference package

bind

public void bind(org.docgene.model.globals.InfoboxDefinition infoboxDef)

Bind the infobox to its associated definition.

Parameters:

infoboxDef - the infobox definition

countProperties

public int countProperties()

Return the number of properties, including the default.

Returns:

the number of properties

getDefinition

public org.docgene.model.globals.InfoboxDefinition getDefinition()

Return the infobox associated definition.

Returns:

the infobox definition

getProperties

public java.util.Map<java.lang.String,XMLInfobox.Property> getProperties()

Return the infobox properties.

Returns:

the properties

addProperty

public XMLInfobox.BaseProperty addProperty(java.lang.String key)

Create a property of a specified key and adds it to the infobox.

Parameters:

key - the property key

Returns:

the property

addEnumProperty

public XMLInfobox.EnumProperty addEnumProperty(java.lang.String key,
                                               java.lang.String state)

Create an enum property of a specified key and adds it to the infobox.

Parameters:

key - the property key

state - the proeprty state

Returns:

the property

hasProperty

public boolean hasProperty(java.lang.String key)

Return true if the infobox has a property of a specified key.

Parameters:

key - the property key

Returns:

true if the infobox has a property with the specified key

getProperty

public XMLInfobox.Property getProperty(java.lang.String key)

Return the property of a specified key.

Parameters:

key - the property key

Returns:

the property

hasCaption

public boolean hasCaption()

Return true if the infobox has a caption. There is a caption if there is a property with the PROPERTY_NAME key.

Returns:

true if the infobox has a caption

getCaption

public java.lang.String getCaption()

Return the infobox caption. The caption is the property of the PROPERTY_NAME key, if it exists.

Returns:

the infobox caption

addElement

public void addElement(ParagraphElement element)

Description copied from interface: ParagraphElementParent

Add an element.

Specified by:

addElement in interface ParagraphElementParent

Parameters:

element - the element

getElements

public java.util.List<ParagraphElement> getElements()

Description copied from interface: ParagraphElementParent

Return the list of children elements.

Specified by:

getElements in interface ParagraphElementParent

Returns:

the list of children elements

setElements

public void setElements(java.util.List<ParagraphElement> elements)

Description copied from interface: ParagraphElementParent

Set the list of elements.

Specified by:

setElements in interface ParagraphElementParent

Parameters:

elements - the list of elements