Package com.luciad.view.lightspeed.style.styler

Class TLspLabelStyler.Builder

java.lang.Object
com.luciad.view.lightspeed.style.styler.TLspLabelStyler.Builder
Enclosing class:
TLspLabelStyler
public static class TLspLabelStyler.Builder extends Object
Builder for static label styler.
Since:
2012.0

  • Constructor Details

    • Builder

      public Builder()
      Default constructor.

  • Method Details

    • group

      public TLspLabelStyler.Builder group(String aGroupID)
      Specifies the declutter group the label(s) should be in.

      By default, DEFAULT_DECLUTTER_GROUP is used.

      Parameters:
      aGroupID - The desired declutter group.
      Returns:
      this builder.
      See Also:

    • priority

      public TLspLabelStyler.Builder priority(int aPriority)
      Specifies a fixed priority for the label(s).

      By default, labels have priority Integer.MAX_VALUE, low priority.

      You can only call this method or priority(ILspLabelPriorityProvider) once, not both.

      Parameters:
      aPriority - The desired priority, 0 being highest priority.
      Returns:
      this builder.

    • priority

      public TLspLabelStyler.Builder priority(ILspLabelPriorityProvider aPriorityProvider)
      Specifies a priority provider for the label(s).

      By default, labels have priority Integer.MAX_VALUE, low priority.

      You can only use priority(int) or this method once, not both.

      Parameters:
      aPriorityProvider - The priority provider that can specify priorities.
      Returns:
      this builder.

    • locations

      public TLspLabelStyler.Builder locations(int aShift, TLspLabelLocationProvider.Location... aLocations)
      Specifies a set of fixed locations to be used for the label(s).

      You can only use this method or algorithm once, never more.

      Parameters:
      aShift - the amount of pixels the labels must be removed from the object anchor point.
      aLocations - a list of possible locations to place the labels.
      Returns:
      this builder.

    • locations

      public TLspLabelStyler.Builder locations(TLspLabelLocationProvider.Location... aLocations)
      Specifies a set of fixed locations to be used for the label(s).

      You can only use one locations or algorithm call, never more.

      Parameters:
      aLocations - a list of possible locations to place the labels.
      Returns:
      this builder.

    • algorithm

      public TLspLabelStyler.Builder algorithm(ILspLabelingAlgorithm aAlgorithm)
      Specifies the labeling algorithm to be used for the label(s).

      You can call either locations or this method, never more.

      Parameters:
      aAlgorithm - The algorithm to be used.
      Returns:
      this builder.

    • algorithm

      public TLspLabelStyler.Builder algorithm(ILspLabelingAlgorithmProvider aAlgorithmProvider)
      Specifies the labeling algorithm provider to be used for the label(s).

      You can only use one locations or algorithm call, never more.

      Parameters:
      aAlgorithmProvider - The algorithm provider to be used.
      Returns:
      this builder.

    • styler

      public TLspLabelStyler.Builder styler(ILspStyler aDelegateStyler)
      Sets a delegate styler.

      This styler will be called for all objects.

      You can only call this method or styles, never both.

      Parameters:
      aDelegateStyler - the delegate styler.
      Returns:
      this builder.

    • styles

      public TLspLabelStyler.Builder styles(ALspStyle... aStyles)
      Specifies a list of styles to be applied to all objects.

      You can only call styler or this method, never both.

      Note that getStyles() returns these styles, wrapped with a TLspCustomizableStyle.

      Parameters:
      aStyles - The styles to apply.
      Returns:
      this builder.

    • customizableStyles

      public TLspLabelStyler.Builder customizableStyles(TLspCustomizableStyle... aStyles)
      Specifies a list of styles to be applied to all objects.

      You can only call styler or styles, never both.

      Parameters:
      aStyles - The styles to apply.
      Returns:
      this builder.

    • all

      public TLspLabelStyler.Builder all(TLspLabelStyler aLabelStyler)
      Copies all properties from the given styler.
      Parameters:
      aLabelStyler - the styler to copy
      Returns:
      this

    • build

      public TLspLabelStyler build()
      Builds the static label styler.
      Returns:
      the static label styler using the set parameters.