Package com.jbstrap.jbmap.layers
Interface TooltipLayer<T extends BaseLayer<?>>
- Type Parameters:
T
- The layer class type
public interface TooltipLayer<T extends BaseLayer<?>>
Implementing this interface makes the
TooltipLayer
class accessible to the tile layers. The class enables you to specify the settings of a layer tooltip.- Since:
- 4.0
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptiondefault T
Programmatically closes the tooltip.default String
Gets the specified tooltip content.default boolean
Gets the tooltip display status.default boolean
Gets the tooltip's display status: programmatically displayed or not.default T
Programmatically opens the tooltip.default T
setTooltipContent
(String tooltipContent) Sets the tooltip content.default T
setTooltipEnabled
(boolean tooltipEnabled) Sets the tooltip display mode (enabled/disabled).
-
Field Details
-
TOOLTIP_CONTENT
- See Also:
-
TOOLTIP_ENABLED
- See Also:
-
TOOLTIP_OPENED
- See Also:
-
-
Method Details
-
isTooltipOpened
default boolean isTooltipOpened()Gets the tooltip's display status: programmatically displayed or not.- Returns:
true
if theopenTooltip()
was used previouslyfalse
, if thecloseTooltip()
was used previously The default value isfalse
.
-
openTooltip
Programmatically opens the tooltip.- Returns:
- Layer class instance
-
closeTooltip
Programmatically closes the tooltip.- Returns:
- Layer class instance
-
getTooltipContent
Gets the specified tooltip content.- Returns:
- Tooltip content By default, the value is
null
.
-
setTooltipContent
Sets the tooltip content.- Parameters:
tooltipContent
- Tooltip content- Returns:
- Layer class instance
-
isTooltipEnabled
default boolean isTooltipEnabled()Gets the tooltip display status.- Returns:
true
if the tooltip is enabled If not enabled, it isfalse
.
-
setTooltipEnabled
Sets the tooltip display mode (enabled/disabled).- Parameters:
tooltipEnabled
- Enables or disables the tooltip display- Returns:
- Layer class instance
-