M
- the data type of the legendpublic class Legend<M> extends Object implements LegendHandler.HasLegendHandlers, LegendSelectionEvent.HasLegendSelectionHandlers, LegendItemOutEvent.HasLegendItemOutHandlers, LegendItemOverEvent.HasLegendItemOverHandlers, LegendItemUpEvent.HasLegendItemUpHandlers
Modifier and Type | Field and Description |
---|---|
protected ToolTip |
toolTip |
protected LegendToolTipConfig<M> |
toolTipConfig |
Constructor and Description |
---|
Legend() |
Modifier and Type | Method and Description |
---|---|
HandlerRegistration |
addLegendHandler(LegendHandler handler)
Adds a
LegendHandler handler for LegendSelectionEvent ,
LegendItemOutEvent , LegendItemOverEvent and
LegendItemUpEvent events. |
HandlerRegistration |
addLegendItemOutHandler(LegendItemOutEvent.LegendItemOutHandler handler)
Adds a
LegendItemOutEvent.LegendItemOutHandler handler for
LegendItemOutEvent events. |
HandlerRegistration |
addLegendItemOverHandler(LegendItemOverEvent.LegendItemOverHandler handler)
Adds a
LegendItemOverEvent.LegendItemOverHandler handler for
LegendItemOverEvent events. |
HandlerRegistration |
addLegendItemUpHandler(LegendItemUpEvent.LegendItemUpHandler handler)
Adds a
LegendItemUpEvent.LegendItemUpHandler handler for
LegendItemUpEvent events. |
HandlerRegistration |
addLegendSelectionHandler(LegendSelectionEvent.LegendSelectionHandler handler)
Adds a
LegendSelectionEvent.LegendSelectionHandler handler for
LegendSelectionEvent events. |
void |
clear()
Removes all the sprites of the legend from the surface.
|
void |
create()
Create all the sprites for the legend.
|
protected HandlerManager |
ensureHandlers() |
PreciseRectangle |
getBBox()
Calculates and returns the bounding box of the legend.
|
RectangleSprite |
getBorderConfig()
Returns the border configuration.
|
Chart<M> |
getChart()
Returns the chart that the legend is attached.
|
List<String> |
getCurrentLegendTitles()
Returns the current list of titles used in the legend.
|
int |
getItemFromPoint(PrecisePoint point)
Returns the
LegendItem at the given point. |
List<LegendItem<M>> |
getItems() |
SeriesRenderer<M> |
getLabelRenderer()
Returns the series renderer for label sprites on the legend.
|
int |
getLegendInset()
Returns the inset margin used by the legend.
|
SeriesRenderer<M> |
getLineRenderer()
Returns the series renderer for line sprites on the legend.
|
SeriesRenderer<M> |
getMarkerRenderer()
Returns the series renderer for marker sprites on the legend.
|
double |
getPadding()
Returns the padding between legend items.
|
Chart.Position |
getPosition()
Returns the position of the legend.
|
ToolTip |
getToolTip()
Returns the currently generated tooltip for legend.
|
LegendToolTipConfig<M> |
getToolTipConfig()
Returns the tool tip configuration of the legend.
|
boolean |
isItemHiding()
Returns true if legend item hiding is enabled.
|
boolean |
isItemHighlighting()
Returns true if legend item highlighting is enabled.
|
protected void |
onMouseDown(PrecisePoint point,
Event event) |
protected int |
onMouseMove(PrecisePoint point,
Event event) |
protected void |
onMouseOut(int index,
Event event) |
protected void |
onMouseUp(PrecisePoint point,
Event event) |
void |
removeToolTip()
Removes the components tooltip (if one exists).
|
void |
setBorderConfig(RectangleSprite borderConfig)
Sets the border configuration.
|
void |
setChart(Chart<M> chart)
Sets the chart that the legend is attached.
|
void |
setItemHiding(boolean itemHiding)
Sets whether or not the legend uses item highlighting.
|
void |
setItemHighlighting(boolean itemHighlighting)
Sets whether or not the legend uses item highlighting.
|
void |
setLabelRenderer(SeriesRenderer<M> labelRenderer)
Sets the series renderer for label sprites on the legend.
|
void |
setLegendInset(int legendInset)
Sets the inset margin used by the legend.
|
void |
setLineRenderer(SeriesRenderer<M> lineRenderer)
Sets the series renderer for line sprites on the legend.
|
void |
setMarkerRenderer(SeriesRenderer<M> markerRenderer)
Sets the series renderer for marker sprites on the legend.
|
void |
setPadding(double padding)
Sets the padding between legend items.
|
void |
setPosition(Chart.Position position)
Sets the position of the legend.
|
void |
setToolTipConfig(LegendToolTipConfig<M> config)
Sets the tooltip configuration.
|
void |
updatePosition()
Adjusts the position of the legend to fit in its chart.
|
protected ToolTip toolTip
protected LegendToolTipConfig<M> toolTipConfig
public HandlerRegistration addLegendHandler(LegendHandler handler)
LegendHandler.HasLegendHandlers
LegendHandler
handler for LegendSelectionEvent
,
LegendItemOutEvent
, LegendItemOverEvent
and
LegendItemUpEvent
events.addLegendHandler
in interface LegendHandler.HasLegendHandlers
handler
- the handlerpublic HandlerRegistration addLegendItemOutHandler(LegendItemOutEvent.LegendItemOutHandler handler)
LegendItemOutEvent.HasLegendItemOutHandlers
LegendItemOutEvent.LegendItemOutHandler
handler for
LegendItemOutEvent
events.addLegendItemOutHandler
in interface LegendItemOutEvent.HasLegendItemOutHandlers
handler
- the handlerpublic HandlerRegistration addLegendItemOverHandler(LegendItemOverEvent.LegendItemOverHandler handler)
LegendItemOverEvent.HasLegendItemOverHandlers
LegendItemOverEvent.LegendItemOverHandler
handler for
LegendItemOverEvent
events.addLegendItemOverHandler
in interface LegendItemOverEvent.HasLegendItemOverHandlers
handler
- the handlerpublic HandlerRegistration addLegendItemUpHandler(LegendItemUpEvent.LegendItemUpHandler handler)
LegendItemUpEvent.HasLegendItemUpHandlers
LegendItemUpEvent.LegendItemUpHandler
handler for
LegendItemUpEvent
events.addLegendItemUpHandler
in interface LegendItemUpEvent.HasLegendItemUpHandlers
handler
- the handlerpublic HandlerRegistration addLegendSelectionHandler(LegendSelectionEvent.LegendSelectionHandler handler)
LegendSelectionEvent.HasLegendSelectionHandlers
LegendSelectionEvent.LegendSelectionHandler
handler for
LegendSelectionEvent
events.addLegendSelectionHandler
in interface LegendSelectionEvent.HasLegendSelectionHandlers
handler
- the handlerpublic void clear()
public void create()
public PreciseRectangle getBBox()
public RectangleSprite getBorderConfig()
public Chart<M> getChart()
public List<String> getCurrentLegendTitles()
public int getItemFromPoint(PrecisePoint point)
LegendItem
at the given point. Returns null if no item
at that point.point
- the point of the itempublic List<LegendItem<M>> getItems()
public SeriesRenderer<M> getLabelRenderer()
public int getLegendInset()
public SeriesRenderer<M> getLineRenderer()
public SeriesRenderer<M> getMarkerRenderer()
public double getPadding()
public Chart.Position getPosition()
public ToolTip getToolTip()
public LegendToolTipConfig<M> getToolTipConfig()
public boolean isItemHiding()
public boolean isItemHighlighting()
public void removeToolTip()
public void setBorderConfig(RectangleSprite borderConfig)
borderConfig
- the border configurationpublic void setChart(Chart<M> chart)
chart
- the chart that the legend is attachedpublic void setItemHiding(boolean itemHiding)
itemHiding
- true if the legend uses item highlightingpublic void setItemHighlighting(boolean itemHighlighting)
itemHighlighting
- ture if the legend uses item highlightingpublic void setLabelRenderer(SeriesRenderer<M> labelRenderer)
labelRenderer
- the series renderer for label sprites on the legendpublic void setLegendInset(int legendInset)
legendInset
- the inset margin used by the legendpublic void setLineRenderer(SeriesRenderer<M> lineRenderer)
lineRenderer
- the series renderer for line sprites on the legendpublic void setMarkerRenderer(SeriesRenderer<M> markerRenderer)
markerRenderer
- the series renderer for marker sprites on the legendpublic void setPadding(double padding)
padding
- the padding between legend itemspublic void setPosition(Chart.Position position)
position
- the position of the legendpublic void setToolTipConfig(LegendToolTipConfig<M> config)
config
- the tooltip configurationpublic void updatePosition()
protected HandlerManager ensureHandlers()
protected void onMouseDown(PrecisePoint point, Event event)
protected int onMouseMove(PrecisePoint point, Event event)
protected void onMouseOut(int index, Event event)
protected void onMouseUp(PrecisePoint point, Event event)
Copyright © 2018. All rights reserved.