com.moximedia.aims.pdf
Class Box

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

public class Box
extends java.lang.Object
implements Item, java.lang.Cloneable, java.io.Serializable

A template item object implementation. The Box object is used to define a rectangular area 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
Box()
          Creates a new instance of Box
 
Method Summary
 java.lang.Object clone()
          Gets a clone of this object.
 Box 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.
 java.lang.String toString()
          Overrides Object.toString() method.
 void write(com.lowagie.text.pdf.PdfWriter writer)
          Writes the template item to the PDF document.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Box

public Box()
Creates a new instance of Box

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

Returns:
A copy of this object.

write

public void write(com.lowagie.text.pdf.PdfWriter writer)
Writes the template item to the PDF document.

Parameters:
writer - The PdfWriter object to write to.

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

toString

public java.lang.String toString()
Overrides Object.toString() method.

Returns:
A string representation of this object.


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.