Interface ICloudLabelProvider
-
- All Superinterfaces:
IBaseLabelProvider
- All Known Subinterfaces:
IEditableCloudLabelProvider
- All Known Implementing Classes:
TypeLabelProvider
public interface ICloudLabelProvider extends IBaseLabelProvider
Defines the label of an element within the cloud. Besides of the string-label, each element can be assigned a unique weight (used to calculate the font size of the rendered element), color, font and angle.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description float
getAngle(java.lang.Object element)
The angle of the element, which must be between -90 and 90, inclusive.Color
getColor(java.lang.Object element)
TheColor
of the given element, which must not benull
.FontData[]
getFontData(java.lang.Object element)
TheFontData
-array which defines the font of the given element.java.lang.String
getLabel(java.lang.Object element)
The label of the given element, which must not benull
.java.lang.String
getToolTip(java.lang.Object element)
Return the tool tip of the element, ornull
, if none.double
getWeight(java.lang.Object element)
The weight of the given element, which must be between 0 and 1 (inclusive).-
Methods inherited from interface org.eclipse.jface.viewers.IBaseLabelProvider
addListener, dispose, isLabelProperty, removeListener
-
-
-
-
Method Detail
-
getLabel
java.lang.String getLabel(java.lang.Object element)
The label of the given element, which must not benull
.- Parameters:
element
-- Returns:
- the label of the given element
-
getWeight
double getWeight(java.lang.Object element)
The weight of the given element, which must be between 0 and 1 (inclusive).- Parameters:
element
-- Returns:
- the weight of the given element
-
getColor
Color getColor(java.lang.Object element)
TheColor
of the given element, which must not benull
.- Parameters:
element
-- Returns:
- the color of the given element
-
getFontData
FontData[] getFontData(java.lang.Object element)
TheFontData
-array which defines the font of the given element. Each element must be provided with a unique array. Must not returnnull
.- Parameters:
element
-- Returns:
- the font data for the given element
-
getAngle
float getAngle(java.lang.Object element)
The angle of the element, which must be between -90 and 90, inclusive.- Parameters:
element
-- Returns:
- the angle of the given element
-
getToolTip
java.lang.String getToolTip(java.lang.Object element)
Return the tool tip of the element, ornull
, if none.- Parameters:
element
-- Returns:
- the tooltip of the given element
-
-