com.luciad.view.map.multilevelgrid

LuciadLightspeedClass ALcdMultilevelGridCoordinateFormat

java.lang.Object

java.text.Format

com.luciad.view.map.multilevelgrid.ALcdMultilevelGridCoordinateFormat

All Implemented Interfaces:

Serializable, Cloneable

public abstract class ALcdMultilevelGridCoordinateFormat
extends Format

An abstract Format that splits up formatting an ILcdMultilevelGridCoordinate into formatting the levels of the multilevel grid coordinate.

Since:

7.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.text.Format

Format.Field

Constructor Summary

Constructors

Constructor and Description
ALcdMultilevelGridCoordinateFormat()

Method Summary

Modifier and Type	Method and Description
Object	clone() Calls super.clone() as this object has no state.
StringBuffer	format(Object aObject, StringBuffer aStringBuffer, FieldPosition aPosition) Formats a ILcdMultilevelGridCoordinate into a human readable form by calling formatCoordinate(ILcdMultilevelGridCoordinate, int, StringBuffer, java.text.FieldPosition) for every level for which the coordinate is specified.
abstract StringBuffer	formatCoordinate(ILcdMultilevelGridCoordinate aMultilevelGridCoordinate, int aLevel, StringBuffer aStringBuffer, FieldPosition aPosition) This method is called from format(Object, StringBuffer, java.text.FieldPosition) for every level for which the coordinate was specified.

Methods inherited from class java.text.Format

format, formatToCharacterIterator, parseObject, parseObject

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ALcdMultilevelGridCoordinateFormat

public ALcdMultilevelGridCoordinateFormat()

Method Detail

format

public StringBuffer format(Object aObject,
                           StringBuffer aStringBuffer,
                           FieldPosition aPosition)

Formats a ILcdMultilevelGridCoordinate into a human readable form by calling formatCoordinate(ILcdMultilevelGridCoordinate, int, StringBuffer, java.text.FieldPosition) for every level for which the coordinate is specified.

Specified by:

format in class Format

Parameters:

aObject - the ILcdMultilevelGridCoordinate to return a human readable form for.

aStringBuffer - the StringBuffer to append to or to modify.

aPosition - a FieldPosition identifying a field in the formatted text.

Returns:

a StringBuffer containing a human readable representation of the object passed.

Throws:

IllegalArgumentException - when the object passed is not a ILcdMultilevelGridCoordinate

See Also:

formatCoordinate(ILcdMultilevelGridCoordinate, int, StringBuffer, java.text.FieldPosition)

formatCoordinate

public abstract StringBuffer formatCoordinate(ILcdMultilevelGridCoordinate aMultilevelGridCoordinate,
                                              int aLevel,
                                              StringBuffer aStringBuffer,
                                              FieldPosition aPosition)

This method is called from format(Object, StringBuffer, java.text.FieldPosition) for every level for which the coordinate was specified.

Parameters:

aMultilevelGridCoordinate - the coordinate to format.

aLevel - the level of the coordinate to format.

aStringBuffer - contains the human readable representation of the levels with lower index.

aPosition - A FieldPosition identifying a field in the formatted text.

Returns:

a StringBuffer containing at least a human readable representation of the coordinate at the given level.

See Also:

format(Object, StringBuffer, java.text.FieldPosition)

clone

public Object clone()

Calls super.clone() as this object has no state.

Overrides:

clone in class Format

Returns:

a clone of this Format.