com.softwarefx.chartfx.server.maps
Class LabelStylesSettings

java.lang.Object
  com.softwarefx.chartfx.server.maps.LabelStylesSettings

public class LabelStylesSettings
extends Object

Provides access to the LabelStylesSettings object

The LabelStylesSettings class support members which allow you to configure the style in which labels will be displayed in the map. Members provide the developer the ablilty to display no labels, parent labels, labels for a current RuleLevel, etc.

The LabelStyles property of the Map class also support these label style properties through the use of flags and bitwise operators.

Constructor Summary

LabelStylesSettings()

Method Summary

boolean	isDontShowParentLevels() Gets the DontShowParentLevels.
boolean	isShowNothing() Gets the ShowNothing.
boolean	isShowRegionBorders() Gets the ShowRegionBorders.
boolean	isShowThisLevelOnly() Gets the ShowThisLevelOnly.
void	setDontShowParentLevels(boolean value) Sets a value indicating whether parent level labels will be displayed.
void	setShowNothing(boolean value) Sets a value indicating whether all map labels are displayed.
void	setShowRegionBorders(boolean value) Toggle showing region borders.
void	setShowThisLevelOnly(boolean value) Sets a value indicating whether map labels are displayed for the current RuleLevel or for all levels.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LabelStylesSettings

public LabelStylesSettings()

Method Detail

isDontShowParentLevels

public boolean isDontShowParentLevels()

Gets the DontShowParentLevels. For more detail see setDontShowParentLevels(boolean).

isShowNothing

public boolean isShowNothing()

Gets the ShowNothing. For more detail see setShowNothing(boolean).

isShowRegionBorders

public boolean isShowRegionBorders()

Gets the ShowRegionBorders. For more detail see setShowRegionBorders(boolean).

isShowThisLevelOnly

public boolean isShowThisLevelOnly()

Gets the ShowThisLevelOnly. For more detail see setShowThisLevelOnly(boolean).

setDontShowParentLevels

public void setDontShowParentLevels(boolean value)

Sets a value indicating whether parent level labels will be displayed.

Remarks:

This Boolean property allows you to show or hide the labels for parent levels of the current #RuleLevel. The Map.setLabelStyles(java.util.EnumSet) property may be used to set these attributes as switches (using bitwise operators).

The Map.getLabelStylesSettings() property returns the LabelStylesSettings object for the map, which exposes this property.

The setShowThisLevelOnly(boolean) property is used to show labels for the current RuleLevel or for all levels.

To hide labels for all groups, you can use the setShowNothing(boolean) property.

The #RuleLevel property is used to specify which SVG group level to apply the ConditionalAttributes of the map.

See Also:

Map.setLabelStyles(java.util.EnumSet), Map.getLabelStylesSettings(), #setRuleLevel, setShowThisLevelOnly(boolean), setShowNothing(boolean), Map

setShowNothing

public void setShowNothing(boolean value)

Sets a value indicating whether all map labels are displayed.

Remarks:

This Boolean property allows you to show or hide the labels for parent levels of the current #RuleLevel. The Map.setLabelStyles(java.util.EnumSet) property may be used to set these attributes as switches (using bitwise operators).Map.setLabelStyles(java.util.EnumSet)

The Map.getLabelStylesSettings() property returns the LabelStylesSettings object for the map, which exposes this property.

The setDontShowParentLevels(boolean) property allows you to display the labels for lower levels only, parent level labels will not be displayed.

The setShowThisLevelOnly(boolean) property is used to show labels for the current RuleLevel or for all levels.

The #RuleLevel property is used to specify which SVG group level to apply the ConditionalAttributes of the map.

See Also:

Map.setLabelStyles(java.util.EnumSet), Map.getLabelStylesSettings(), setDontShowParentLevels(boolean), setShowThisLevelOnly(boolean), #setRuleLevel, Map

setShowRegionBorders

public void setShowRegionBorders(boolean value)

Toggle showing region borders.

Remarks:

If a generated map contains regions, then the automatically generated borders can be disabled via this property.

setShowThisLevelOnly

public void setShowThisLevelOnly(boolean value)

Sets a value indicating whether map labels are displayed for the current RuleLevel or for all levels.

Remarks:

This Boolean property allows you to show or hide the labels for parent levels of the current #RuleLevel. The Map.setLabelStyles(java.util.EnumSet) property may be used to set these attributes as switches (using bitwise operators).

The Map.getLabelStylesSettings() property returns the LabelStylesSettings object for the map, which exposes this property.

The setDontShowParentLevels(boolean) property allows you to display the labels for lower levels only, parent level labels will not be displayed.

To hide labels for all groups, you can use the setShowNothing(boolean) property.

The #RuleLevel property is used to specify which SVG group level to apply the ConditionalAttributes of the map.

See Also:

Map.setLabelStyles(java.util.EnumSet), Map.getLabelStylesSettings(), setDontShowParentLevels(boolean), setShowNothing(boolean), #setRuleLevel, Map