LabelsConfiguration (JMap 7.0 Kathmandu API Documentation)

java.lang.Object
- com.kheops.jmap.metadata.LocalizedObject
- - com.kheops.jmap.client.layers.LabelsConfiguration

All Implemented Interfaces:: java.io.Serializable, java.lang.Cloneable

public class LabelsConfiguration
extends LocalizedObject
implements java.io.Serializable, java.lang.Cloneable

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LabelsConfiguration.LabelPriority

static class LabelsConfiguration.PositioningType

Nested Classes
Modifier and Type	Class and Description
`static class`	`LabelsConfiguration.LabelPriority`
`static class`	`LabelsConfiguration.PositioningType`

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`allowsOverlappingLabels` Defines if labels can overlap, overriding the project flag
`protected boolean`	`allowsPartialLabels` Defines if labels can be partially included in the map (edges of the view)
`protected Attribute`	`angleAttribute` Defines the attribute that contain the rotation angle (in degrees).
`protected boolean`	`autoLabelling` If autoLabel is active, labels will be drawn for all the elements if the current scale is somewhere between the the maximum and minimum scale limits.
`static int`	`CLOCKWISE` Deprecated. Use the constant CLOCKWISE from the class GeometryUtil
`static int`	`COUNTERCLOCKWISE` Deprecated. Use the constant COUNTERCLOCKWISE from the class GeometryUtil
`protected boolean`	`curvedLabels` Defines if labels follow the curve of a polyline.
`static java.lang.Integer`	`DEFAULT_LAYER_PRIORITY`
`static LabelsConfiguration.PositioningType`	`DEFAULT_POSITIONING_TYPE`
`protected boolean`	`drawFrame`
`protected boolean`	`dynamicPlacement` Defines if labels can be dynamically placed to improve their visibility on the map.
`protected double`	`fixedScale`
`protected boolean`	`followMapRotation` Defines if labels should follow map rotation.
`static java.util.Comparator<LabelsConfiguration.LabelPriority>`	`LABEL_PRIORITY_COMPARATOR`
`protected int`	`labelPosition` Defines the the position of the label in reference to the corresponding element the position are represented the same way as in the LayerInfo class ( where NORTH_WEST = 0 ,NORTH = 1 ...)
`protected java.lang.String`	`labelText`
`protected double`	`maximumScale` Defines the current maximum scale at which the labels should be drawn on a layer if autoLabel mode is active.
`protected double`	`minimumScale` Sets the current minimum scale at which the labels should be drawn on a layer if autoLabel mode is active.
`protected int`	`offsetX`
`protected int`	`offsetY`
`protected boolean`	`orientedLabels` Defines if labels should be oriented when drawn on polylines.
`protected boolean`	`parseNumericLabels`
`protected boolean`	`preventLabelDuplication` Defines if labels duplication should be prevent.
`protected int`	`rotationDirection` Defines the direction of the labels rotation (CLOCKWISE or COUNTERCLOCKWISE).
`protected GeometryUtil.RotationOrigin`	`rotationOrigin`
`protected int`	`rotationUnit` Defines the unit of the labels rotation (DEGREE or RADIAN).
`protected boolean`	`symbolUnderLabels`

Constructor Summary

Constructors
Constructor and Description

LabelsConfiguration()

Constructors
Constructor and Description
`LabelsConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()`
`boolean`	`doOrientedLabels()` Deprecated. use isOrientedLabels() instead
`boolean`	`doPreventLabelDuplication()` Deprecated. use isPreventLabelDuplication() instead
`Attribute`	`getAngleAttribute()`
`java.awt.Color`	`getDrawFrameBorderColor()`
`java.awt.Color`	`getDrawFrameColor()` Returns the color of the polygon frame drawn behind the label.
`double`	`getFixedScale()`
`java.lang.String`	`getLabelText()`
`java.lang.String`	`getLabelText(java.util.Locale locale)` Returns the label text value for for a specific locale.
`java.lang.Integer`	`getLayerPriority()`
`double`	`getMaximumScale()` Returns the maximum scale for drawing labels.
`double`	`getMinimumScale()` Returns the minimum scale for drawing labels.
`int`	`getOffsetX()`
`int`	`getOffsetY()`
`int`	`getPosition()` Returns the label relative position.
`LabelsConfiguration.PositioningType`	`getPositioningType()`
`int[]`	`getPositionPriority()`
`Attribute`	`getPriorityAttribute()`
`int`	`getRotationDirection()`
`GeometryUtil.RotationOrigin`	`getRotationOrigin()`
`int`	`getRotationUnit()`
`Attribute`	`getScaleAttribute()`
`boolean`	`isAllowsOverlappingLabels()` Returns whether or not labels overlapping is permitted.
`boolean`	`isAllowsPartialLabels()` Returns whether or not partial labels are permitted.
`boolean`	`isAutoLabelling()` Returns whether or not automatic labelling is enabled.
`boolean`	`isCurvedLabels()` Returns whether or not curved labels is enabled.
`boolean`	`isDrawable(double scale)` Returns true if labels should be drawn at the specified scale.
`boolean`	`isDrawFrame()` Indicates whether a polygon frame should be drawn behind the label.
`boolean`	`isDynamicPlacement()` Returns whether or not dynamic placement is enabled.
`boolean`	`isFollowMapRotation()`
`boolean`	`isFollowSymbolPosition()`
`boolean`	`isOrientedLabels()` Returns whether or not labels should be drawn oriented.
`boolean`	`isParseNumericLabels()`
`boolean`	`isPreventLabelDuplication()` Returns whether or not labels duplication prevention is enabled.
`boolean`	`isPriorityAttributeReversed()`
`boolean`	`isSymbolUnderLabels()`
`void`	`removeTranslationsOtherThan(java.util.Locale[] locales)` Removes any `Locale` from this object that are not in the specified `locales`.
`void`	`setAllowsOverlappingLabels(boolean allowsOverlappingLabels)` Sets whether or not labels overlapping is permitted.
`void`	`setAllowsPartialLabels(boolean allowsPartialLabels)` Sets whether or not partial labels are permitted.
`void`	`setAngleAttribute(Attribute angleAttribute)`
`void`	`setAutoLabelling(boolean autoLabelling)` Sets whether or not automatic labelling is enabled.
`void`	`setCurvedLabels(boolean curvedLabels)` Sets whether or not curved labels is enabled.
`void`	`setDrawFrame(boolean drawFrame)` Sets whether a polygon frame should be drawn behind the label.
`void`	`setDrawFrameBorderColor(java.awt.Color drawFrameBorderColor)`
`void`	`setDrawFrameColor(java.awt.Color drawFrameColor)` Sets the color of the polygon frame drawn behind the label.
`void`	`setDynamicPlacement(boolean dynamicPlacement)` Sets whether or not dynamic placement is enabled.
`void`	`setFixedScale(double fixedScale)`
`void`	`setFollowMapRotation(boolean mapRotationIgnored)`
`void`	`setFollowSymbolPosition(boolean followSymbolPosition)`
`void`	`setLabelText(java.lang.String labelText)`
`void`	`setLabelText(java.lang.String labelText, java.util.Locale locale)` Sets the label text text with the specified string for a specific locale.
`void`	`setLayerPriority(java.lang.Integer layerPriority)`
`void`	`setMaximumScale(double maximumScale)` Sets the maximum scale for drawing labels.
`void`	`setMinimumScale(double minimumScale)` Sets the minimum scale for drawing labels.
`void`	`setOffsetX(int offsetX)`
`void`	`setOffsetY(int offsetY)`
`void`	`setOrientedLabels(boolean orientedLabels)` Sets whether or not label should be drawn oriented on linear geometries.
`void`	`setParseNumericLabels(boolean parseNumericLabels)`
`void`	`setPosition(int labelPosition)` Sets the label relative position.
`void`	`setPositioningType(LabelsConfiguration.PositioningType positioningType)`
`void`	`setPositionPriority(int[] positionPriority)`
`void`	`setPreventLabelDuplication(boolean preventLabelDuplication)` Enables or disables labels duplication prevention.
`void`	`setPriorityAttribute(Attribute priorityAttribute)`
`void`	`setPriorityAttributeReversed(boolean priorityAttributeReversed)`
`void`	`setRotationDirection(int rotationDirection)`
`void`	`setRotationOrigin(GeometryUtil.RotationOrigin rotationOrigin)`
`void`	`setRotationUnit(int rotationUnit)`
`void`	`setScaleAttribute(Attribute scaleAttribute)`
`void`	`setSymbolUnderLabels(boolean symbolUnderLabels)`

Methods inherited from class com.kheops.jmap.metadata.LocalizedObject
getAvailableLocales, getTranslation, isTranslationExists, setTranslation, updateTranslations

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LABEL_PRIORITY_COMPARATOR
```
public static final java.util.Comparator<LabelsConfiguration.LabelPriority> LABEL_PRIORITY_COMPARATOR
```
  - DEFAULT_POSITIONING_TYPE
```
public static final LabelsConfiguration.PositioningType DEFAULT_POSITIONING_TYPE
```
  - DEFAULT_LAYER_PRIORITY
```
public static final java.lang.Integer DEFAULT_LAYER_PRIORITY
```
  - CLOCKWISE
```
@Deprecated
public static final int CLOCKWISE
```
    Deprecated. Use the constant CLOCKWISE from the class GeometryUtil
    
    Constant for the clockwise direction.
    
    See Also:
    
    Constant Field Values
  - COUNTERCLOCKWISE
```
@Deprecated
public static final int COUNTERCLOCKWISE
```
    Deprecated. Use the constant COUNTERCLOCKWISE from the class GeometryUtil
    
    Constant for the counterclockwise direction.
    
    See Also:
    
    Constant Field Values
  - minimumScale
```
protected double minimumScale
```
    Sets the current minimum scale at which the labels should be drawn on a layer if autoLabel mode is active.
  - maximumScale
```
protected double maximumScale
```
    Defines the current maximum scale at which the labels should be drawn on a layer if autoLabel mode is active.
  - autoLabelling
```
protected boolean autoLabelling
```
    If autoLabel is active, labels will be drawn for all the elements if the current scale is somewhere between the the maximum and minimum scale limits.
  - orientedLabels
```
protected boolean orientedLabels
```
    Defines if labels should be oriented when drawn on polylines.
  - preventLabelDuplication
```
protected boolean preventLabelDuplication
```
    Defines if labels duplication should be prevent.
  - allowsOverlappingLabels
```
protected boolean allowsOverlappingLabels
```
    Defines if labels can overlap, overriding the project flag
  - allowsPartialLabels
```
protected boolean allowsPartialLabels
```
    Defines if labels can be partially included in the map (edges of the view)
  - dynamicPlacement
```
protected boolean dynamicPlacement
```
    Defines if labels can be dynamically placed to improve their visibility on the map.
  - symbolUnderLabels
```
protected boolean symbolUnderLabels
```
  - parseNumericLabels
```
protected boolean parseNumericLabels
```
  - labelPosition
```
protected int labelPosition
```
    Defines the the position of the label in reference to the corresponding element the position are represented the same way as in the LayerInfo class ( where NORTH_WEST = 0 ,NORTH = 1 ...)
    
    See Also:
    
    LabelManager
  - fixedScale
```
protected double fixedScale
```
  - offsetX
```
protected int offsetX
```
  - offsetY
```
protected int offsetY
```
  - angleAttribute
```
protected Attribute angleAttribute
```
    Defines the attribute that contain the rotation angle (in degrees).
  - rotationDirection
```
protected int rotationDirection
```
    Defines the direction of the labels rotation (CLOCKWISE or COUNTERCLOCKWISE).
  - rotationUnit
```
protected int rotationUnit
```
    Defines the unit of the labels rotation (DEGREE or RADIAN).
  - rotationOrigin
```
protected GeometryUtil.RotationOrigin rotationOrigin
```
  - followMapRotation
```
protected boolean followMapRotation
```
    Defines if labels should follow map rotation.
  - labelText
```
protected java.lang.String labelText
```
  - drawFrame
```
protected boolean drawFrame
```
  - curvedLabels
```
protected boolean curvedLabels
```
    Defines if labels follow the curve of a polyline.
- Constructor Detail
  - LabelsConfiguration
```
public LabelsConfiguration()
```
- Method Detail
  - getAngleAttribute
```
public Attribute getAngleAttribute()
```
  - setAngleAttribute
```
public void setAngleAttribute(Attribute angleAttribute)
```
  - getRotationDirection
```
public int getRotationDirection()
```
  - setRotationDirection
```
public void setRotationDirection(int rotationDirection)
```
  - getRotationUnit
```
public int getRotationUnit()
```
  - setRotationUnit
```
public void setRotationUnit(int rotationUnit)
```
  - isFollowMapRotation
```
public boolean isFollowMapRotation()
```
  - setFollowMapRotation
```
public void setFollowMapRotation(boolean mapRotationIgnored)
```
  - getLabelText
```
public java.lang.String getLabelText()
```
  - getLabelText
```
public java.lang.String getLabelText(java.util.Locale locale)
```
    Returns the label text value for for a specific locale.
    
    Parameters:
    
    locale -
    
    Returns:
    
    the label text
  - setLabelText
```
public void setLabelText(java.lang.String labelText)
```
  - setLabelText
```
public void setLabelText(java.lang.String labelText,
                         java.util.Locale locale)
```
    Sets the label text text with the specified string for a specific locale.
    
    Parameters:
    
    labelText - the new label text text
    
    locale -
  - isDrawable
```
public boolean isDrawable(double scale)
```
    Returns true if labels should be drawn at the specified scale. This is based on the minimum and maximum zoom scales stored in this labels configuration.
    
    Parameters:
    
    scale - the scale used for the calculation.
    
    Returns:
    
    true if labels should be drawn at the specified scale.
  - getPosition
```
public int getPosition()
```
    Returns the label relative position.
    
    Returns:
    
    the label relative position.
    
    See Also:
    
    LabelManager
  - setPosition
```
public void setPosition(int labelPosition)
```
    Sets the label relative position.
    
    Parameters:
    
    labelPosition - the label relative position.
    
    See Also:
    
    LabelManager
  - getMaximumScale
```
public double getMaximumScale()
```
    Returns the maximum scale for drawing labels.
    
    Returns:
    
    the maximum scale.
  - setMaximumScale
```
public void setMaximumScale(double maximumScale)
```
    Sets the maximum scale for drawing labels.
    
    Parameters:
    
    maximumScale - the maximum scale.
  - getMinimumScale
```
public double getMinimumScale()
```
    Returns the minimum scale for drawing labels.
    
    Returns:
    
    the minimum scale.
  - setMinimumScale
```
public void setMinimumScale(double minimumScale)
```
    Sets the minimum scale for drawing labels.
    
    Parameters:
    
    minimumScale - the minimum scale.
  - isAutoLabelling
```
public boolean isAutoLabelling()
```
    Returns whether or not automatic labelling is enabled.
    
    Returns:
    
    whether or not automatic labelling is enabled.
  - setAutoLabelling
```
public void setAutoLabelling(boolean autoLabelling)
```
    Sets whether or not automatic labelling is enabled.
    
    Parameters:
    
    autoLabelling - the new state of the property.
  - doOrientedLabels
```
@Deprecated
public boolean doOrientedLabels()
```
    Deprecated. use isOrientedLabels() instead
    
    Returns whether or not labels should be drawn oriented.
    
    Returns:
    
    whether or not labels should be drawn oriented.
  - isOrientedLabels
```
public boolean isOrientedLabels()
```
    Returns whether or not labels should be drawn oriented.
    
    Returns:
    
    whether or not labels should be drawn oriented.
    
    Since:
    
    6.0
  - doPreventLabelDuplication
```
@Deprecated
public boolean doPreventLabelDuplication()
```
    Deprecated. use isPreventLabelDuplication() instead
    
    Returns whether or not labels duplication prevention is enabled.
    
    Returns:
    
    whether or not labels duplication prevention is enabled.
  - isPreventLabelDuplication
```
public boolean isPreventLabelDuplication()
```
    Returns whether or not labels duplication prevention is enabled.
    
    Returns:
    
    whether or not labels duplication prevention is enabled.
    
    Since:
    
    6.0
  - setPreventLabelDuplication
```
public void setPreventLabelDuplication(boolean preventLabelDuplication)
```
    Enables or disables labels duplication prevention.
    
    Parameters:
    
    preventLabelDuplication - the new state of the property.
  - setOrientedLabels
```
public void setOrientedLabels(boolean orientedLabels)
```
    Sets whether or not label should be drawn oriented on linear geometries.
    
    Parameters:
    
    orientedLabels - the new state of the property.
  - isAllowsOverlappingLabels
```
public boolean isAllowsOverlappingLabels()
```
    Returns whether or not labels overlapping is permitted.
    
    Returns:
    
    whether or not labels overlapping is permitted.
  - setAllowsOverlappingLabels
```
public void setAllowsOverlappingLabels(boolean allowsOverlappingLabels)
```
    Sets whether or not labels overlapping is permitted.
    
    Parameters:
    
    allowsOverlappingLabels - the flag state.
  - setParseNumericLabels
```
public void setParseNumericLabels(boolean parseNumericLabels)
```
  - isParseNumericLabels
```
public boolean isParseNumericLabels()
```
  - isSymbolUnderLabels
```
public boolean isSymbolUnderLabels()
```
  - setSymbolUnderLabels
```
public void setSymbolUnderLabels(boolean symbolUnderLabels)
```
  - getFixedScale
```
public double getFixedScale()
```
  - setFixedScale
```
public void setFixedScale(double fixedScale)
```
  - getOffsetX
```
public int getOffsetX()
```
  - setOffsetX
```
public void setOffsetX(int offsetX)
```
  - getOffsetY
```
public int getOffsetY()
```
  - setOffsetY
```
public void setOffsetY(int offsetY)
```
  - clone
```
public java.lang.Object clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - isDrawFrame
```
public boolean isDrawFrame()
```
    Indicates whether a polygon frame should be drawn behind the label.
    
    Returns:
    
    true if frame must be drawn
  - setDrawFrame
```
public void setDrawFrame(boolean drawFrame)
```
    Sets whether a polygon frame should be drawn behind the label.
    
    Parameters:
    
    drawFrame - true if frame must be drawn
  - getDrawFrameColor
```
public java.awt.Color getDrawFrameColor()
```
    Returns the color of the polygon frame drawn behind the label.
    
    Returns:
    
    color of the polygon
    
    Since:
    
    6.0
  - setDrawFrameColor
```
public void setDrawFrameColor(java.awt.Color drawFrameColor)
```
    Sets the color of the polygon frame drawn behind the label.
    
    Parameters:
    
    drawFrameColor - the color of the polygon
    
    Since:
    
    6.0
  - isAllowsPartialLabels
```
public boolean isAllowsPartialLabels()
```
    Returns whether or not partial labels are permitted.
    
    Returns:
    
    whether or not partial labels overlapping are permitted.
  - setAllowsPartialLabels
```
public void setAllowsPartialLabels(boolean allowsPartialLabels)
```
    Sets whether or not partial labels are permitted.
  - isDynamicPlacement
```
public boolean isDynamicPlacement()
```
    Returns whether or not dynamic placement is enabled.
    
    Returns:
    
    whether or not dynamic placement is enabled.
  - setDynamicPlacement
```
public void setDynamicPlacement(boolean dynamicPlacement)
```
    Sets whether or not dynamic placement is enabled.
  - isCurvedLabels
```
public boolean isCurvedLabels()
```
    Returns whether or not curved labels is enabled. This property applies only on Polylines.
    
    Returns:
    
    whether or not curved labels is enabled.
  - setCurvedLabels
```
public void setCurvedLabels(boolean curvedLabels)
```
    Sets whether or not curved labels is enabled. This property applies only on Polylines.
  - getDrawFrameBorderColor
```
public java.awt.Color getDrawFrameBorderColor()
```
  - setDrawFrameBorderColor
```
public void setDrawFrameBorderColor(java.awt.Color drawFrameBorderColor)
```
  - getRotationOrigin
```
public GeometryUtil.RotationOrigin getRotationOrigin()
```
  - setRotationOrigin
```
public void setRotationOrigin(GeometryUtil.RotationOrigin rotationOrigin)
```
  - getScaleAttribute
```
public Attribute getScaleAttribute()
```
  - setScaleAttribute
```
public void setScaleAttribute(Attribute scaleAttribute)
```
  - getPositioningType
```
public LabelsConfiguration.PositioningType getPositioningType()
```
  - setPositioningType
```
public void setPositioningType(LabelsConfiguration.PositioningType positioningType)
```
  - getPositionPriority
```
public int[] getPositionPriority()
```
  - setPositionPriority
```
public void setPositionPriority(int[] positionPriority)
```
  - getLayerPriority
```
public java.lang.Integer getLayerPriority()
```
  - setLayerPriority
```
public void setLayerPriority(java.lang.Integer layerPriority)
```
  - getPriorityAttribute
```
public Attribute getPriorityAttribute()
```
  - setPriorityAttribute
```
public void setPriorityAttribute(Attribute priorityAttribute)
```
  - isPriorityAttributeReversed
```
public boolean isPriorityAttributeReversed()
```
  - setPriorityAttributeReversed
```
public void setPriorityAttributeReversed(boolean priorityAttributeReversed)
```
  - isFollowSymbolPosition
```
public boolean isFollowSymbolPosition()
```
  - setFollowSymbolPosition
```
public void setFollowSymbolPosition(boolean followSymbolPosition)
```
  - removeTranslationsOtherThan
```
public void removeTranslationsOtherThan(java.util.Locale[] locales)
```
    Description copied from class: LocalizedObject
    
    Removes any Locale from this object that are not in the specified locales. locales[0] should be the default language
    
    Overrides:
    
    removeTranslationsOtherThan in class LocalizedObject

Class LabelsConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.kheops.jmap.metadata.LocalizedObject

Methods inherited from class java.lang.Object

Field Detail

LABEL_PRIORITY_COMPARATOR

DEFAULT_POSITIONING_TYPE

DEFAULT_LAYER_PRIORITY

CLOCKWISE

COUNTERCLOCKWISE

minimumScale

maximumScale

autoLabelling

orientedLabels

preventLabelDuplication

allowsOverlappingLabels

allowsPartialLabels

dynamicPlacement

symbolUnderLabels

parseNumericLabels

labelPosition

fixedScale

offsetX

offsetY

angleAttribute

rotationDirection

rotationUnit

rotationOrigin

followMapRotation

labelText

drawFrame

curvedLabels

Constructor Detail

LabelsConfiguration

Method Detail

getAngleAttribute

setAngleAttribute

getRotationDirection

setRotationDirection

getRotationUnit

setRotationUnit

isFollowMapRotation

setFollowMapRotation

getLabelText

getLabelText

setLabelText

setLabelText

isDrawable

getPosition

setPosition

getMaximumScale

setMaximumScale

getMinimumScale

setMinimumScale

isAutoLabelling

setAutoLabelling

doOrientedLabels

isOrientedLabels

doPreventLabelDuplication

isPreventLabelDuplication

setPreventLabelDuplication

setOrientedLabels

isAllowsOverlappingLabels

setAllowsOverlappingLabels

setParseNumericLabels

isParseNumericLabels

isSymbolUnderLabels

setSymbolUnderLabels

getFixedScale

setFixedScale

getOffsetX

setOffsetX

getOffsetY

setOffsetY

clone

isDrawFrame

setDrawFrame