Package com.luciad.view.map.painter

Class TLcdLonLatGridPainter

java.lang.Object
com.luciad.view.gxy.ALcdGXYPainter
com.luciad.view.map.painter.TLcdLonLatGridPainter
All Implemented Interfaces:
ILcdCloneable, ILcdPropertyChangeSource, ILcdGXYPainter, ILcdGXYPainterProvider, Serializable, Cloneable
public class TLcdLonLatGridPainter extends ALcdGXYPainter implements ILcdGXYPainter
This ILcdGXYPainter paints TLcdLonLatGrid instances. By default, the meridians and parallels are painted as gray lines, except for the equator and the Greenwich meridian, which are painted in red. By default, labels are painted in gray, slanted along the grid lines, at a small offset from the edge of the view and from the grid lines. These style properties can all be modified.

This painter can optionally add a halo effect to the labels it draws. For a more detailed explanation of halos, please refer to TLcdGXYHaloLabelPainter. The methods that control the appearance of the halos are equivalent to those in TLcdGXYHaloLabelPainter.

See Also:

  • Field Details

    • ABOVE

      public static final int ABOVE
      Label alignment mode, indicating that the label is positioned above the chosen line segment.
      See Also:

    • CENTER

      public static final int CENTER
      Label alignment mode, indicating that the label center is positioned on the chosen line segment.
      See Also:

    • BELOW

      public static final int BELOW
      Label alignment mode, indicating that the label is positioned below the chosen line segment.
      See Also:

  • Constructor Details

    • TLcdLonLatGridPainter

      public TLcdLonLatGridPainter()
      Constructs a new TLcdLonLatGridPainter object.

  • Method Details

    • getColor

      public Color getColor()
      Returns the color that is used to paint the grid lines.

    • setColor

      public void setColor(Color aColor)
      Sets the color to be used to paint the grid lines.

    • getZeroColor

      public Color getZeroColor()
      Returns the color that is used to paint the Greenwich meridian and the equator.

    • setZeroColor

      public void setZeroColor(Color aZeroColor)
      Sets the color to be used to paint the Greenwich meridian and the equator.

    • isLabeled

      public boolean isLabeled()
      Returns whether the grid labels are painted.

    • setLabeled

      public void setLabeled(boolean aLabeled)
      Specifies whether the grid labels should be painted.

    • getLabelPosition

      public TLcdLonLatGridPainter.LabelPosition getLabelPosition()
      Returns where grid labels are positioned.
      Returns:
      the position of the grid labels
      See Also:

    • setLabelPosition

      public void setLabelPosition(TLcdLonLatGridPainter.LabelPosition aLabelPosition)
      Determines where grid labels are positioned.
      Parameters:
      aLabelPosition - the desired position of the labels
      See Also:

    • isLabelHaloEnabled

      public boolean isLabelHaloEnabled()
      Returns whether the painter will add a halo effect around the grid labels.
      Returns:
      whether the painter will add a halo effect around the grid labels.
      See Also:

    • setLabelHaloEnabled

      public void setLabelHaloEnabled(boolean aHaloEnabled)
      Determines whether the painter will add a halo effect around the grid labels. By default, this property is set to false.
      Parameters:
      aHaloEnabled - a flag indicating whether to add a halo effect around the grid labels.
      See Also:

    • getLabelHaloThickness

      public int getLabelHaloThickness()
      Returns the thickness of the halo effect for the grid labels.
      Returns:
      the thickness of the halo effect for the grid labels.
      See Also:

    • setLabelHaloThickness

      public void setLabelHaloThickness(int aHaloThickness)
      Sets the thickness defined in pixels of the halo effect for the grid labels. By default, this property is set to 1.
      Parameters:
      aHaloThickness - the thickness defined in pixels of the halo effect for the grid labels.
      See Also:

    • getLabelHaloColor

      public Color getLabelHaloColor()
      Returns the color of the halo effect.
      Returns:
      the color of the halo effect.
      See Also:

    • setLabelHaloColor

      public void setLabelHaloColor(Color aHaloColor)
      Sets the color of the halo effect for the grid labels. By default, this property is set to Color.white.
      Parameters:
      aHaloColor - the color of the halo effect for the grid labels.
      See Also:

    • getLonLatFormatter

      public ILcdLonLatFormatter getLonLatFormatter()
      Returns the formatter that is used for the grid labels.

    • setLonLatFormatter

      public void setLonLatFormatter(ILcdLonLatFormatter aLonLatFormatter)
      Sets the formatter to be used for the grid labels.
      Parameters:
      aLonLatFormatter - the new formatter to use. The formatter must implement ILcdCloneable if it should be cloned when this painter is cloned.

    • isSlantedLabels

      public boolean isSlantedLabels()
      Returns whether the grid labels are painted at an angle.

    • setSlantedLabels

      public void setSlantedLabels(boolean aSlantedLabels)
      Specifies whether the grid labels should be painted at an angle.

    • getLabelColor

      public Color getLabelColor()
      Returns the color that is to paint the grid labels.

    • setLabelColor

      public void setLabelColor(Color aLabelColor)
      Sets the color to be used to paint the grid labels.

    • getLabelFont

      public Font getLabelFont()
      Returns the Font for the grid labels.

    • setLabelFont

      public void setLabelFont(Font aLabelFont)
      Sets the Font for the grid labels.

    • getLabelGridOffset

      public int getLabelGridOffset()
      Returns the offset between the grid labels and their grid lines.
      Returns:
      the label grid offset, expressed in pixels.

    • setLabelGridOffset

      public void setLabelGridOffset(int aLabelGridOffset)
      Sets the offset between the grid labels and their grid lines.
      Parameters:
      aLabelGridOffset - the label grid offset, expressed in pixels.

    • getLabelEdgeOffset

      public int getLabelEdgeOffset()
      Returns the minimum offset between the grid labels and the edge of the view.
      Returns:
      the label edge offset, expressed in pixels.

    • setLabelEdgeOffset

      public void setLabelEdgeOffset(int aLabelEdgeOffset)
      Sets the minimum offset between the grid labels and the edge of the view.
      Parameters:
      aLabelEdgeOffset - the label edge offset, expressed in pixels.

    • setLabelAlignment

      public void setLabelAlignment(int aAlignment)
      Sets how a grid label is aligned with respect to the grid line.
      Parameters:
      aAlignment - one of ABOVE, CENTER, or BELOW
      See Also:

    • getLabelAlignment

      public int getLabelAlignment()
      Returns how a grid label is aligned with respect to the grid line.
      Returns:
      one of ABOVE, CENTER, or BELOW
      See Also:

    • setLabelBackgroundColor

      public void setLabelBackgroundColor(Color aBackgroundColor)
      Sets the color of the grid label frames filling to aBackgroundColor.
      Parameters:
      aBackgroundColor - the color to be used for the grid label frames filling.
      See Also:

    • getLabelBackgroundColor

      public Color getLabelBackgroundColor()
      Returns the color of the label frames filling.
      Returns:
      the color of the label frames filling.
      See Also:

    • setLabelFrame

      public void setLabelFrame(boolean aFramed)
      Sets whether or not to surround the labels with a frame.
      Parameters:
      aFramed - true to paint the labels in a frame.
      See Also:

    • isLabelFrame

      public boolean isLabelFrame()
      Returns whether to surround labels with a frame.
      Returns:
      whether labels will be painted in frames.
      See Also:

    • setLabelFilled

      public void setLabelFilled(boolean aFilled)
      Sets whether to surround labels with a filled background.
      Parameters:
      aFilled - true to paint labels with a filled background.
      See Also:

    • isLabelFilled

      public boolean isLabelFilled()
      Returns whether to surround labels with a filled background.
      Returns:
      true if labels are surround with a filled background, false otherwise
      See Also:

    • setLabelMargin

      public void setLabelMargin(int aMargin)
      Sets the amount of the padding margin around the label text, in pixels. If the frame is painted, it will be painted around this margin.
      Parameters:
      aMargin - the new margin size, in pixels
      See Also:

    • getLabelMargin

      public int getLabelMargin()
      Returns the amount of padding used around the text.
      Returns:
      the padding around the text, in pixels
      See Also:

    • setObject

      public void setObject(Object aObject)
      Description copied from interface: ILcdGXYPainter
      Sets the Object for which the representation shall be handled by this painter.

      Setting the object on the painter may have an effect on the internal state of the painter, for example, the color to use.

      When the object is set to a painter, the context parameter in subsequent calls to methods in this class must contain a layer that contains this object and for which the painter for this object is this painter.

      Specified by:
      setObject in interface ILcdGXYPainter
      Parameters:
      aObject - the object for which the representation shall be handled by this painter.
      See Also:

    • getObject

      public Object getObject()
      Description copied from interface: ILcdGXYPainter
      Returns the Object for which the representation is currently being handled by this painter.
      Specified by:
      getObject in interface ILcdGXYPainter
      Returns:
      the Object for which the representation is currently being handled by this painter.
      See Also:

    • paint

      public void paint(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext)
      Description copied from interface: ILcdGXYPainter
      Displays the representation of the object in the given mode on the Graphics passed, taking into account the supplied context.

      The visual representation of an object depends on the context. Depending on the context (e.g. is the location covered by the view), an object may or may not have a representation. The context contains:

      • transformations which allow to compute the location in view space of points and bounds given in model, space
      • a pen which can connect points with a line or create arcs around a point,
      • the view for which the object's representation must be painted. This can be useful when the painted object depends on the scale of the view, or the presence of other layers in the view.
      • the current location(s) of the mouse or input device and the last location(s) the mouse or input device was pressed.

      The mode passed in this method indicates what part of the object must be painted, whether it should be painted as selected or not, and whether user interaction (via mouse movements) must be taken into account.

      When the mode passed contains either TRANSLATING, RESHAPING or CREATING, this method is also responsible for interpreting interaction on the representation of an object and modifying the representation of the object accordingly. The painter is not responsible for modifying the object itself, this is done by a corresponding ILcdGXYEditor . Implementations of ILcdGXYPainter and ILcdGXYEditor interfaces must be consistent for an object: the painter must display the result of the user interaction on the object, while the editor is responsible for modifying the object as a result of the user interaction. A good practice to ensure a consistent implementation is to implement both the ILcdGXYPainter and ILcdGXYEditor interfaces in a single class.

      When the mode passed includes SNAPS, the part of the representation which corresponds to the object returned as snap target by the method snapTarget must be painted in order to provide the user with a visual indication of the snap target.

      The Graphics passed in this method can be different from the Graphics returned by a view due to techniques such as double buffering (as applied in Swing). Basic drawing operations must always be performed on the Graphics passed as an argument in this method.

      Specified by:
      paint in interface ILcdGXYPainter
      Parameters:
      aGraphics - the Graphics on which the representation of the object is painted
      aMode - the mode the object is represented in (see class documentation).
      aGXYContext - the ILcdGXYContext the drawing depends on.

    • isTouched

      public boolean isTouched(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext)
      Description copied from interface: ILcdGXYPainter
      Checks if the representation of the object in the given mode is touched at the location as defined in the supplied context.

      The location that must be taken into account to check whether the representation is touched can be retrieved from the context passed with the methods ILcdGXYContext.getX() and ILcdGXYContext.getY(). If the check is part of an ongoing operation of user interaction, for example, when the mouse is being dragged, the location of the start of the operation can also be taken into account using the methods ILcdGXYContext.getDeltaX() and ILcdGXYContext.getDeltaY(). The context contains the transformations required to convert this location into the equivalent location in model space. Implementations of this interface usually follow either of the following patterns:

      • transform the location of the interaction back to model space and compare the coordinates with the object in model space.
      • transform the location to world space and compare with a world representation of the object. This forces the painter into caching a world representation of the object. Caching a view representation of an object is not very practical as it would have to change whenever the view's scale changes or when it is panned. A world representation of an object only changes when the view's XYWorldReference changes, which happens less frequently.

      As the mode influences the way an object is represented, it must also be taken into account when checking whether that representation is being touched. When the mode contains CREATING, RESHAPING or TRANSLATING which indicate that the object must be represented in a state for an ongoing operation, the location of the start of the operation may be taken into account as mentioned above. The painting result can take into account multiple locations, to respond to, for example, multi-touch input. When the mode contains SELECTED, the painter should also check if the non-selected representation is touched, since these are always painted on top of each other.

      The boundsSFCT is often used to speed up the performance of this method as a location outside these bounds can never touch the representation of the object.

      Note that this method does not give an indication of what part of the object is touched. It is up to the painter implementations to provide methods to make this distinction. The method does also not indicate what sensitivity must be applied when checking if an object is touched. It is up to the implementation to decide what should be the maximum distance between the location given in the context and the closest relevant point or area of the representation of the object.

      Specified by:
      isTouched in interface ILcdGXYPainter
      Parameters:
      aGraphics - the Graphics on which the representation of the object is painted
      aMode - the mode the object is represented in
      aGXYContext - contains the location of the interaction and the transformations to convert this location into model coordinates
      Returns:
      true if the representation of the object in the given mode is touched by the location as defined in the context passed, false otherwise
      See Also:

    • boundsSFCT

      public void boundsSFCT(Graphics aGraphics, int aMode, ILcdGXYContext aGXYContext, ILcd2DEditableBounds aBoundsSFCT)
      Description copied from interface: ILcdGXYPainter
      Sets the supplied bounds (in view coordinates, pixels) so that it encompasses the representation of the object in the given mode taking into account the given context.

      If this method returns without exception the bounds argument must encompass the representation of the object. A point outside the bounds will not be contained within the painted object.

      The bounds returned in this method can be seen as the equivalent in the view space of the bounds in the model space for ILcdBounded objects.

      Specified by:
      boundsSFCT in interface ILcdGXYPainter
      Parameters:
      aGraphics - the Graphics on which the representation of the object is painted
      aMode - the mode the object is represented in (see class documentation). For example, an object may be represented differently in SELECTED mode compared to DEFAULT mode. The returned bounds of the representation must take this different representation into account.
      aGXYContext - the context for which the representation of the object is painted. It contains amongst others the transformations from model to world and world to view.
      aBoundsSFCT - the bounds that must be adapted to encompass the representation of the object in the given mode and context. These bounds must not be taken into account when the method has thrown an exception.
      See Also:

    • clone

      public Object clone()
      Description copied from interface: ILcdCloneable

      Makes Object.clone() public.

      When for example extending from java.lang.Object, it can be implemented like this: 
      
 public Object clone() {
   try {
     return super.clone();
   } catch ( CloneNotSupportedException e ) {
     // Cannot happen: extends from Object and implements Cloneable (see also Object.clone)
     throw new RuntimeException( e );
   }
 }
      Specified by:
      clone in interface ILcdCloneable
      Specified by:
      clone in interface ILcdGXYPainterProvider
      Overrides:
      clone in class ALcdGXYPainter
      Returns:
      a clone of this painter provider.
      See Also: