com.moximedia.aims.pdf
Class Prompt

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

All Implemented Interfaces:

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

public class Prompt

extends java.lang.Object

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

A template item object implementation. This object is used to define a prompt for some text to be drawn on the map.

Author:

Doug Cates - www.moximedia.com

See Also:

Serialized Form

Field Summary

static int	ALIGNMENT_TYPE_CENTER
static int	ALIGNMENT_TYPE_LEFT
static int	ALIGNMENT_TYPE_RIGHT
static int	PROMPT_METHOD_INPUT
static int	PROMPT_METHOD_SELECT
static int	PROMPT_TYPE_PARAGRAPH
static int	PROMPT_TYPE_TEXT

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

Prompt()
Creates a new instance of Prompt

Method Summary

java.lang.Object	clone() Gets a clone of this object.
Prompt	getCopy() Gets a copy of this object.
int	getItemType() Returns the item type enumerator.
int	getPromptMethod() Returns the prompt method type enumerator.
java.lang.String	getPromptName() Returns the prompt text for the request form.
int	getPromptType() Returns the prompt type enumerator.
java.lang.String[]	getSelectOptions() Returns the sekect options.
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 text) 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

PROMPT_TYPE_TEXT

public static final int PROMPT_TYPE_TEXT

See Also:

Constant Field Values

PROMPT_TYPE_PARAGRAPH

public static final int PROMPT_TYPE_PARAGRAPH

See Also:

Constant Field Values

PROMPT_METHOD_INPUT

public static final int PROMPT_METHOD_INPUT

See Also:

Constant Field Values

PROMPT_METHOD_SELECT

public static final int PROMPT_METHOD_SELECT

See Also:

Constant Field Values

ALIGNMENT_TYPE_LEFT

public static final int ALIGNMENT_TYPE_LEFT

See Also:

Constant Field Values

ALIGNMENT_TYPE_RIGHT

public static final int ALIGNMENT_TYPE_RIGHT

See Also:

Constant Field Values

ALIGNMENT_TYPE_CENTER

public static final int ALIGNMENT_TYPE_CENTER

See Also:

Constant Field Values

Constructor Detail

Prompt

public Prompt()

Creates a new instance of Prompt

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

Gets a copy of this object.

Returns:

A copy of this object.

write

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

Writes the template item to the PDF document.

Parameters:

writer - The PdfWriter object to write to.

text - The text to write.

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

getPromptMethod

public int getPromptMethod()

Returns the prompt method type enumerator.

Returns:

Either PROMPT_METHOD_INPUT or PROMPT_METHOD_SELECT.

getPromptType

public int getPromptType()

Returns the prompt type enumerator.

Returns:

Either PROMPT_TYPE_TEXT or PROMPT_TYPE_PARAGRAPH.

getPromptName

public java.lang.String getPromptName()

Returns the prompt text for the request form.

Returns:

The text for the prompt.

getSelectOptions

public java.lang.String[] getSelectOptions()

Returns the sekect options.

Returns:

An array of options for the request form.