com.micello.mapapi.data
Interface InfoObject

All Known Subinterfaces:

MapObject

All Known Implementing Classes:

Community, Entity, GeometryInlay, GeometryOverlay, MarkerOverlay

public interface InfoObject

This interface is shared by all objects which have detail information associated with them, including Community, Geometry and MarkerOverlays.

Nested Class Summary

static class	InfoObject.InfoObjectType This enumeration is used to specify the class of info object.
static class	InfoObject.StandardDetailInfo This is the object that is returned for a detail standard object.

Field Summary

static int	DETAIL_CUSTOM This value indicates the detail is a developer defined custom object.
static int	DETAIL_HTML This value indicates the detail is HTML text.
static int	DETAIL_NONE This value indicates there is no detail for the object.
static int	DETAIL_STANDARD This value indicates that detail info is available remotely from the micello web service.
static int	DETAIL_SUPPRESS This value indicates there is no detail and the info option should be suppressed, if possible.
static int	DETAIL_URL_HTML This value indicates the detail is a URL pointing to HTML.
static int	DETAIL_URL_VALUES This value indicates the detail is a URL pointing to a detail list.
static int	DETAIL_VALUE_LIST This value indicates the detail is a list of DetailValue objects.

Method Summary

java.lang.Object	getDetailObject() This method returns the detail object.
int	getDetailType() This method gets the type of detail this object has.
java.lang.String	getName() A title for the object.

Field Detail

DETAIL_SUPPRESS

static final int DETAIL_SUPPRESS

This value indicates there is no detail and the info option should be suppressed, if possible.

See Also:

Constant Field Values

DETAIL_NONE

static final int DETAIL_NONE

This value indicates there is no detail for the object.

See Also:

Constant Field Values

DETAIL_STANDARD

static final int DETAIL_STANDARD

This value indicates that detail info is available remotely from the micello web service.

See Also:

Constant Field Values

DETAIL_VALUE_LIST

static final int DETAIL_VALUE_LIST

This value indicates the detail is a list of DetailValue objects.

See Also:

Constant Field Values

DETAIL_HTML

static final int DETAIL_HTML

This value indicates the detail is HTML text.

See Also:

Constant Field Values

DETAIL_URL_HTML

static final int DETAIL_URL_HTML

This value indicates the detail is a URL pointing to HTML.

See Also:

Constant Field Values

DETAIL_URL_VALUES

static final int DETAIL_URL_VALUES

This value indicates the detail is a URL pointing to a detail list.

See Also:

Constant Field Values

DETAIL_CUSTOM

static final int DETAIL_CUSTOM

This value indicates the detail is a developer defined custom object.

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

A title for the object.

getDetailType

int getDetailType()

This method gets the type of detail this object has.

Returns:

An integer describing the detail type. See the constants defined for this interface.

getDetailObject

java.lang.Object getDetailObject()

This method returns the detail object. The type of object returned depends on the value of the detail type.