com.moximedia.aims.pdf
Class Legend

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

All Implemented Interfaces:

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

public class Legend

extends java.lang.Object

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

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

Author:

Doug Cates - www.moximedia.com

See Also:

Serialized Form

Field Summary

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

Legend()
Creates a new instance of Legend

Method Summary

java.lang.Object	clone() Gets a clone of this object.
Legend	getCopy() Gets a copy of this object.
int	getItemType() Returns the item type enumerator.
AimsLegend	getLegend() Gets a legend object per the settings of this object.
AimsPoint	getSize() Gets the size of the legend image.
boolean	isValid() Returns an indicator of whether the template object is valid.
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

Constructor Detail

Legend

public Legend()

Creates a new instance of Legend

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

Gets a copy of this object.

Returns:

A copy of this object.

getLegend

public AimsLegend getLegend()

Gets a legend object per the settings of this object.

Returns:

The legend object.

getSize

public AimsPoint getSize()

Gets the size of the legend image.

Returns:

The image 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.

isValid

public boolean isValid()

Returns an indicator of whether the template object is valid. Invalid objects will not be written to the PDF document.

Returns:

True if the object is valid, 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_LEGEND.