org.docgene.model

Class XMLMap

java.lang.Object

org.docgene.model.XMLMap

All Implemented Interfaces:

org.docgene.model.Alignment, ParagraphElement, StyledElement

public class XMLMap
extends java.lang.Object
implements ParagraphElement, org.docgene.model.Alignment

Represent the reference to a Map. Currently only OpenStreetMap maps are allowed

Field Summary

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Fields inherited from interface org.docgene.model.Alignment

CENTER, LEFT, RIGHT

Constructor Summary

Constructors

Constructor and Description
XMLMap(XMLParentArticle article) Constructor.

Method Summary

Modifier and Type	Method and Description
char	getAlignment() Return the alignment of the Map.
XMLParentArticle	getArticle() Return the article in which this Map is used.
java.lang.String	getDeclaration() Return the declaration ID of the element.
int	getHeight() Return the Map height.
double	getLatitudeCenter() Return the map center latitude.
double	getLongitudeCenter() Return the map center lontitude.
java.lang.String	getMapID() Return the ID of the Map in its article.
java.lang.String	getProjection() Return the map projection.
int	getWidth() Return the Map width.
int	getZoomLevel() Return the map zoom level.
boolean	hasHeight() Return true if the Map has a specified height.
boolean	hasSize() Return true if the Map has a specified size.
boolean	hasWidth() Return true if the Map has a specified width.
boolean	isFloat() Return true if the map element should have the "float" attribute.
boolean	isRelativeWidth() Return true if the image width is relative (in %).
void	setAlignment(char align) Set the alignment of the Map.
void	setBounds(double latCenter, double lonCenter, int zoomLevel) Set the map bounds.
void	setFloat(boolean isFloat) Set if the map element should have the "float" attribute.
void	setHeight(int height) Set the Map height.
void	setProjection(java.lang.String projection) Set the map projection.
void	setWidth(int width, boolean relWidth) Set the Map width.

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

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

Constructor Detail

XMLMap

public XMLMap(XMLParentArticle article)

Constructor.

Parameters:

article - the article

Method Detail

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

setProjection

public void setProjection(java.lang.String projection)

Set the map projection.

Parameters:

projection - the map projection

getProjection

public java.lang.String getProjection()

Return the map projection.

Returns:

the map projection

setBounds

public void setBounds(double latCenter,
                      double lonCenter,
                      int zoomLevel)

Set the map bounds.

Parameters:

latCenter - the ap center latitude

lonCenter - the map center lontitude

zoomLevel - the map zoom level

getLatitudeCenter

public double getLatitudeCenter()

Return the map center latitude.

Returns:

the map center latitude

getLongitudeCenter

public double getLongitudeCenter()

Return the map center lontitude.

Returns:

the map center lontitude

getZoomLevel

public int getZoomLevel()

Return the map zoom level.

Returns:

the zoom level

getMapID

public java.lang.String getMapID()

Return the ID of the Map in its article.

Returns:

the ID

getArticle

public XMLParentArticle getArticle()

Return the article in which this Map is used.

Returns:

the article in which this Map is used

setAlignment

public void setAlignment(char align)

Set the alignment of the Map.

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

Specified by:

getAlignment in interface org.docgene.model.Alignment

Returns:

the alignment

See Also:

Alignment

setFloat

public void setFloat(boolean isFloat)

Set if the map element should have the "float" attribute.

Parameters:

isFloat - true if the map element should have the "float" attribute

isFloat

public boolean isFloat()

Return true if the map element should have the "float" attribute.

Returns:

true if the map element should have the "float" attribute

setWidth

public void setWidth(int width,
                     boolean relWidth)

Set the Map width.

Parameters:

width - the Map 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)

Set the Map height.

Parameters:

height - the Map height

getWidth

public int getWidth()

Return the Map width.

Returns:

the Map width

getHeight

public int getHeight()

Return the Map height.

Returns:

the Map height

hasSize

public boolean hasSize()

Return true if the Map has a specified size.

Returns:

true if the Map has a specified size

hasWidth

public boolean hasWidth()

Return true if the Map has a specified width.

Returns:

true if the Map has a specified width

hasHeight

public boolean hasHeight()

Return true if the Map has a specified height.

Returns:

true if the Map has a specified height