com.moximedia.aims.pdf
Class IndexMap

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

All Implemented Interfaces:

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

public class IndexMap

extends java.lang.Object

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

A template item object implementation. This object is used to define the index map to be drawn on the map.

Author:

Doug Cates - www.moximedia.com

See Also:

Serialized Form

Field Summary

static int	VIEW_TYPE_BOX
static int	VIEW_TYPE_CROSSHAIR

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

IndexMap()
Creates a new instance of Map

Method Summary

java.lang.Object	clone() Gets a clone of this object.
IndexMap	getCopy() Gets a copy of this object.
int	getItemType() Returns the item type enumerator.
AimsPoint	getRequestSize() Returns the request size for the index map.
double	getResolution() Gets the resolution of the index map.
AimsPoint	getSize() Returns the print size for the index map.
int	getViewType() Returns the index map view 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, java.lang.String url, boolean isFile) 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

VIEW_TYPE_CROSSHAIR

public static final int VIEW_TYPE_CROSSHAIR

See Also:

Constant Field Values

VIEW_TYPE_BOX

public static final int VIEW_TYPE_BOX

See Also:

Constant Field Values

Constructor Detail

IndexMap

public IndexMap()

Creates a new instance of Map

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 IndexMap getCopy()

Gets a copy of this object.

Returns:

A copy of this object.

getResolution

public double getResolution()

Gets the resolution of the index map.

Returns:

The resolution in dotts per inch.

getRequestSize

public AimsPoint getRequestSize()

Returns the request size for the index map. The request size may be larger than the actual printed size depending on the resolution.

Returns:

The image request size.

getSize

public AimsPoint getSize()

Returns the print size for the index map.

Returns:

The image print size.

write

public void write(com.lowagie.text.pdf.PdfWriter writer,
                  java.lang.String url,
                  boolean isFile)

Writes the template item to the PDF document.

Parameters:

writer - The PdfWriter object to write to.

url - The image URL.

isFile - True if the image URL is a file, otherwise false.

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

getViewType

public int getViewType()

Returns the index map view enumerator.

Returns:

Either IndexMap.VIEW_TYPE_CROSSHAIR or IndexMap.VIEW_TYPE_BOX