Chart FX for Java 6.2

SoftwareFX.ChartFX.Map
Class LabelStylesSettings

java.lang.Object
  extended bySoftwareFX.ChartFX.Map.LabelStylesSettings

public final class LabelStylesSettings
extends java.lang.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 or sets a value indicating whether parent level labels will be displayed.
 boolean isShowNothing()
          Gets or sets a value indicating whether all map labels are displayed.
 boolean isShowRegionBorders()
          Gets or sets a value indicating whether or not to display region borders.
 boolean isShowThisLevelOnly()
          Gets or sets a value indicating whether map labels are displayed for the current DetailLevel or for all levels.
 void setDontShowParentLevels(boolean value)
          Gets or sets a value indicating whether parent level labels will be displayed.
 void setShowNothing(boolean value)
          Gets or sets a value indicating whether all map labels are displayed.
 void setShowRegionBorders(boolean value)
          Gets or sets a value indicating whether or not to display region borders.
 void setShowThisLevelOnly(boolean value)
          Gets or sets a value indicating whether map labels are displayed for the current DetailLevel 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 or 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 Map.setDetailLevel(int). The Map.setLabelStyles(int) 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 DetailLevel or for all levels.

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

  • The Map.setDetailLevel(int) property is used to specify which SVG group level to apply the ConditionalAttributes of the map.

  • See Also:
    Map.setLabelStyles(int), Map.getLabelStylesSettings(), Map.setDetailLevel(int), setShowThisLevelOnly(boolean), setShowNothing(boolean), Map

    isShowNothing

    public boolean isShowNothing()

    Gets or 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 Map.setDetailLevel(int). The Map.setLabelStyles(int) 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.

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

  • The Map.setDetailLevel(int) property is used to specify which SVG group level to apply the ConditionalAttributes of the map.

  • See Also:
    Map.setLabelStyles(int), Map.getLabelStylesSettings(), setDontShowParentLevels(boolean), setShowThisLevelOnly(boolean), Map.setDetailLevel(int), Map

    isShowRegionBorders

    public boolean isShowRegionBorders()

    Gets or sets a value indicating whether or not to display region borders.

    Remarks:
  • 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 setShowThisLevelOnly(boolean) property is used to show labels for the current DetailLevel or for all levels.

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

  • See Also:
    #setDontShowParentLabels, setShowNothing(boolean), setShowThisLevelOnly(boolean), Map.getLabelStylesSettings(), Map

    isShowThisLevelOnly

    public boolean isShowThisLevelOnly()

    Gets or sets a value indicating whether map labels are displayed for the current DetailLevel or for all levels.

    Remarks:
  • This Boolean property allows you to show or hide the labels for parent levels of the current Map.setDetailLevel(int). The Map.setLabelStyles(int) 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 Map.setDetailLevel(int) property is used to specify which SVG group level to apply the ConditionalAttributes of the map.

  • See Also:
    Map.setLabelStyles(int), Map.getLabelStylesSettings(), setDontShowParentLevels(boolean), setShowNothing(boolean), Map.setDetailLevel(int), Map

    setDontShowParentLevels

    public void setDontShowParentLevels(boolean value)

    Gets or 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 Map.setDetailLevel(int). The Map.setLabelStyles(int) 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 DetailLevel or for all levels.

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

  • The Map.setDetailLevel(int) property is used to specify which SVG group level to apply the ConditionalAttributes of the map.

  • See Also:
    Map.setLabelStyles(int), Map.getLabelStylesSettings(), Map.setDetailLevel(int), setShowThisLevelOnly(boolean), setShowNothing(boolean), Map

    setShowNothing

    public void setShowNothing(boolean value)

    Gets or 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 Map.setDetailLevel(int). The Map.setLabelStyles(int) 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.

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

  • The Map.setDetailLevel(int) property is used to specify which SVG group level to apply the ConditionalAttributes of the map.

  • See Also:
    Map.setLabelStyles(int), Map.getLabelStylesSettings(), setDontShowParentLevels(boolean), setShowThisLevelOnly(boolean), Map.setDetailLevel(int), Map

    setShowRegionBorders

    public void setShowRegionBorders(boolean value)

    Gets or sets a value indicating whether or not to display region borders.

    Remarks:
  • 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 setShowThisLevelOnly(boolean) property is used to show labels for the current DetailLevel or for all levels.

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

  • See Also:
    #setDontShowParentLabels, setShowNothing(boolean), setShowThisLevelOnly(boolean), Map.getLabelStylesSettings(), Map

    setShowThisLevelOnly

    public void setShowThisLevelOnly(boolean value)

    Gets or sets a value indicating whether map labels are displayed for the current DetailLevel or for all levels.

    Remarks:
  • This Boolean property allows you to show or hide the labels for parent levels of the current Map.setDetailLevel(int). The Map.setLabelStyles(int) 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 Map.setDetailLevel(int) property is used to specify which SVG group level to apply the ConditionalAttributes of the map.

  • See Also:
    Map.setLabelStyles(int), Map.getLabelStylesSettings(), setDontShowParentLevels(boolean), setShowNothing(boolean), Map.setDetailLevel(int), Map

    http://www.softwarefx.com

    2005 Software FX, Inc. All Rights Reserved. Chart FX is a registered trademark of Software FX, Inc
    All other names are trademarks or registered trademarks of their respective owners.