com.moximedia.aims.pdf
Class NorthArrow

java.lang.Object
  extended bycom.moximedia.aims.pdf.NorthArrow
All Implemented Interfaces:
java.lang.Cloneable, Item, java.io.Serializable

public class NorthArrow
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
 
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
NorthArrow()
          Creates a new instance of NorthArrow
 
Method Summary
 java.lang.Object clone()
          Gets a clone of this object.
 NorthArrow 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, java.lang.String imfPath, java.lang.String printConfigPath)
          Sets a template item property using string values.
 void write(com.lowagie.text.pdf.PdfWriter writer, double mapScale, double angle, java.util.HashMap serverAlias)
          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

NorthArrow

public NorthArrow()
Creates a new instance of NorthArrow

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 NorthArrow getCopy()
Gets a copy of this object.

Returns:
A copy of this object.

write

public void write(com.lowagie.text.pdf.PdfWriter writer,
                  double mapScale,
                  double angle,
                  java.util.HashMap serverAlias)
Writes the template item to the PDF document.

Parameters:
writer - The PdfWriter object to write to.
mapScale - The scale of the map.
angle - The angle to draw the arrow.

setXmlAttribute

public void setXmlAttribute(java.lang.String element,
                            java.lang.String name,
                            java.lang.String value,
                            Template template,
                            java.lang.String imfPath,
                            java.lang.String printConfigPath)
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.
imfPath - The path to the IMF installation directory.
printConfigPath - The path to the print confituration file.

getItemType

public int getItemType()
Returns the item type enumerator.

Specified by:
getItemType in interface Item
Returns:
Always returns Item.ITEM_TYPE_NORTHARROW.


Internet Mapping Framework for ArcIMS Java Object Model API (v5.1.00)
Copyright © 2006 Moxi Media Inc. and Province of British Columbia. All Rights Reserved.