com.moximedia.aims.pdf
Class ScaleBar

java.lang.Object
  com.moximedia.aims.pdf.ScaleBar

All Implemented Interfaces:

java.lang.Cloneable, Item, java.io.Serializable

public class ScaleBar

extends java.lang.Object

implements Item, java.lang.Cloneable, java.io.Serializable

Author:

jdc

See Also:

Serialized Form

Field Summary

int	SCALEBAR_TEXT_POSITION_BOTTOM
int	SCALEBAR_TEXT_POSITION_TOP
int	SCALEBAR_UNITS_IMPERIAL
int	SCALEBAR_UNITS_METRIC
int	SCALEBAR_UNITS_METRIC_US

Fields inherited from interface com.moximedia.aims.pdf.Item

ITEM_TYPE_BOX, ITEM_TYPE_CENTERCOORDINATETEXT, ITEM_TYPE_DATETEXT, ITEM_TYPE_IMAGE, ITEM_TYPE_INDEXMAP, ITEM_TYPE_LATLONGRATICULE, ITEM_TYPE_LEGEND, ITEM_TYPE_LINE, ITEM_TYPE_MAP, ITEM_TYPE_NORTHARROW, ITEM_TYPE_PARAGRAPH, ITEM_TYPE_PROMPT, ITEM_TYPE_SCALEBAR, ITEM_TYPE_SCALETEXT, ITEM_TYPE_TEXT, ITEM_TYPE_TITLETEXT

Constructor Summary

ScaleBar()
Creates a new instance of ScaleBar

Method Summary

java.lang.Object	clone() Gets a clone of this object.
ScaleBar	getCopy() Gets a copy of this object.
int	getItemType() Returns the item type enumerator.
void	setXmlAttribute(java.lang.String element, java.lang.String name, java.lang.String value, Template template) Sets a template item property using string values.
void	write(com.lowagie.text.pdf.PdfWriter writer, double scale, Projection mapProjection) Writes the template item to the PDF document.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SCALEBAR_UNITS_METRIC

public final int SCALEBAR_UNITS_METRIC

See Also:

Constant Field Values

SCALEBAR_UNITS_METRIC_US

public final int SCALEBAR_UNITS_METRIC_US

See Also:

Constant Field Values

SCALEBAR_UNITS_IMPERIAL

public final int SCALEBAR_UNITS_IMPERIAL

See Also:

Constant Field Values

SCALEBAR_TEXT_POSITION_TOP

public final int SCALEBAR_TEXT_POSITION_TOP

See Also:

Constant Field Values

SCALEBAR_TEXT_POSITION_BOTTOM

public final int SCALEBAR_TEXT_POSITION_BOTTOM

See Also:

Constant Field Values

Constructor Detail

ScaleBar

public ScaleBar()

Creates a new instance of ScaleBar

Method Detail

clone

public java.lang.Object clone()

Gets a clone of this object.

Specified by:

clone in interface Item

Returns:

A clone of this object.

getCopy

public ScaleBar getCopy()

Gets a copy of this object.

Returns:

A copy of this object.

write

public void write(com.lowagie.text.pdf.PdfWriter writer,
                  double scale,
                  Projection mapProjection)

Writes the template item to the PDF document.

Parameters:

writer - The PdfWriter object to write to.

scale - The map scale. param mapProjection The map projection.

setXmlAttribute

public void setXmlAttribute(java.lang.String element,
                            java.lang.String name,
                            java.lang.String value,
                            Template template)

Sets a template item property using string values. Commonly used when setting the properties when using an XML parser.

Parameters:

element - The element name.

name - The attribute name.

value - The attribute value.

template - The template object used to convert units.

getItemType

public int getItemType()

Returns the item type enumerator.

Specified by:

getItemType in interface Item

Returns:

Always returns Item.ITEM_TYPE_SCALEBAR.