目录

public final class TileOverlay

Represents a tile overlay. A tile overlay is a set of images to be displayed on a map. It can be transparent and enable you to add new functions to an existing map.

Public Fields

None.

Constructor

None.

Public Method Summary

Return typeMethod name
voidclearTileCache()
booleanequals(Object other)
booleangetFadeIn()
StringgetId()
floatgetTransparency()
floatgetZIndex()
inthashCode()
booleanisVisible()
voidremove()
voidsetFadeIn(boolean fadeIn)
voidsetTransparency(float transparency)
voidsetVisible(boolean visible)
voidsetZIndex(float zIndex)

Public Methods

Method
public void clearTileCache()
Clears the cache of a tile overlay.


Parameters:
None.
Return:
None.


Method
public boolean equals(Object other)
Checks whether a tile overlay object equals another.


Parameters:

Parameter nameParameter desc
otherName of another tile overlay object.


Return:

Return typeParameter desc
booleanIf the tile overlay objects are equal, true is returned. Otherwise, false is returned.
Method
public boolean getFadeIn()
Checks whether a tile overlay fades in.


Parameters:
None.
Return:

Return typeParameter desc
booleanWhether a tile overlay fades in.
Method
public String getId()
Obtains the ID of a tile overlay on a map. The ID will be unique among all tile overlays on a map.


Parameters:
None.
Return:

Return typeParameter desc
StringID of a tile overlay.
Method
public float getTransparency()
Obtains the transparency of a tile overlay.


Parameters:
None.
Return:

Return typeParameter desc
floatTransparency of a tile overlay. The value ranges from 0 (completely opaque) to 1 (completely transparent).
Method
public float getZIndex()
Obtains the z-index of a tile overlay.


Parameters:
None.
Return:

Return typeParameter desc
floatZ-index, which indicates the overlapping order of a tile overlay.
Method
public int hashCode()
Obtains the hash code of a tile overlay.


Parameters:
None.
Return:

Return typeParameter desc
intHash code of a tile overlay.
Method
public boolean isVisible()
Checks whether a tile overlay is visible.


Parameters:
None.
Return:

Return typeParameter desc
booleanIf a tile overlay is visible, true is returned. Otherwise, false is returned.

Method
public void remove()
Removes a tile overlay from a map.


Parameters:
None.
Return:
None.

Method
public void setFadeIn(boolean fadeIn)
Specifies whether to make a tile overlay fade in.


Parameters:

Parameter nameParameter desc
fadeInIndicates whether to make a tile overlay fade in.


Return:
None.

Method
public void setTransparency(float transparency)
Sets the transparency of a tile overlay.


Parameters:

Parameter nameParameter desc
transparencyTransparency of a tile overlay. The value ranges from 0 (completely opaque) to 1 (completely transparent).


Return:
None.

Method
public void setVisible(boolean visible)
Specifies whether a tile overlay is visible. If the tile overlay is invisible, it will not be drawn but all other states will be preserved. By default, a tile overlay is visible.


Parameters:

Parameter nameParameter desc
visibleIf a tile overlay is visible, true is returned. Otherwise, false is returned.


Return:
None.

Method
public void setZIndex(float zIndex)
Sets the z-index of a tile overlay. The z-index indicates the overlapping order of a tile overlay. A tile overlay with a larger z-index overlaps that with a smaller z-index. Tile overlays with the same z-index overlap each other in a random order. By default, the z-index is 0.


Parameters:

Parameter nameParameter desc
zIndexZ-index, which indicates the overlapping order of a tile overlay.


Return:
None.