com.esri.map
Class MapTip

java.lang.Object
  com.esri.map.MapTip

public class MapTip
extends Object

Holder of MapTip information.

Since:

10.1.1

Constructor Summary

MapTip()
Creates a maptip with the default display field of the layer.

MapTip(LinkedHashMap<String,String> displayFields)
Creates a maptip with the provided display fields.

Method Summary

Color	getBackground() Returns the background.
Border	getBorder() Returns the border.
LinkedHashMap<String,String>	getDisplayFields() Returns the display fields used.
Font	getFont() Returns the font used.
Color	getForeground() Returns the foreground.
boolean	isEnabled() Returns whether the maptip is enabled.
void	setBackground(Color background) Sets the background.
void	setBorder(Border border) Sets the border to be used.
void	setDisplayFields(LinkedHashMap<String,String> displayFields) Sets the display fields.
void	setEnabled(boolean enabled) Set to true to enable maptip, false, otherwise.
void	setFont(Font font) Sets the font to be used.
void	setForeground(Color foreground) Sets the foreground.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapTip

public MapTip(LinkedHashMap<String,String> displayFields)

Creates a maptip with the provided display fields.

Parameters:

displayFields - fields to be displayed in this maptip.

MapTip

public MapTip()

Creates a maptip with the default display field of the layer.

Method Detail

setDisplayFields

public void setDisplayFields(LinkedHashMap<String,String> displayFields)

Sets the display fields.

Parameters:

displayFields - fields to be displayed in this maptip.

getDisplayFields

public LinkedHashMap<String,String> getDisplayFields()

Returns the display fields used.

Returns:

the display fields.

getBackground

public Color getBackground()

Returns the background.

Returns:

the background color.

setBackground

public void setBackground(Color background)

Sets the background.

Parameters:

background - the color to be used for background.

getBorder

public Border getBorder()

Returns the border.

Returns:

the border used.

setBorder

public void setBorder(Border border)

Sets the border to be used.

Parameters:

border - the border to be used.

getForeground

public Color getForeground()

Returns the foreground.

Returns:

the color of the maptip text.

setForeground

public void setForeground(Color foreground)

Sets the foreground.

Parameters:

foreground - the color of the text to be used.

getFont

public Font getFont()

Returns the font used.

Returns:

the font used.

setFont

public void setFont(Font font)

Sets the font to be used.

Parameters:

font - the font to be used.

isEnabled

public boolean isEnabled()

Returns whether the maptip is enabled.

Returns:

true, if enabled; false, otherwise.

setEnabled

public void setEnabled(boolean enabled)

Set to true to enable maptip, false, otherwise.

Parameters:

enabled - flag to indicate whether to enable maptip.