Package com.luciad.view.gxy.painter

Class TLcdGXYTextPainter

java.lang.Object
com.luciad.view.gxy.ALcdGXYPainter
com.luciad.view.gxy.painter.TLcdGXYTextPainter
All Implemented Interfaces:
ILcdCloneable, ILcdPropertyChangeSource, ILcdGXYEditor, ILcdGXYEditorProvider, ILcdGXYPainter, ILcdGXYPainterProvider, Serializable, Cloneable
public class TLcdGXYTextPainter extends ALcdGXYPainter implements ILcdGXYPainter, ILcdGXYEditorProvider, ILcdGXYEditor
Paints and locates ILcdText objects and enables visual editing of ILcd2DEditableText objects in an ILcdGXYView.

Painting an ILcdText

Body

This painter does not provides different paint modes to paint the body of an ILcdText object. However, a number of properties can be set to change the visualization of the text:


At ext
A framed text
A filled text
A filled and framed text
A text
A framed text
A filled text
A filled and framed text

Handles

This painter defines the four corner points of the ILcdText object as a handle of the text. The following image clarifies the handle location, the corner points are represented by red points.

The different handles

Snap targets

This painter does not support snapping.

Styling options

The visualization of the ILcdText object is governed by the font style, frame style and fill style set to this painter. Depending on the different paint properties some of these will be taken into account.

Locating an ILcdText in a view

Anchor point of an ILcdText

The anchor point of the ILcdText object is located at the center point of the bounds, calculated by boundsSFCT.

When is an ILcdText touched

A ILcdText object is touched when the mouse pointer is located within the rotated bounds of the text.

Visually editing an ILcd2DEditableText

Modifying an ILcd2DEditableText

To edit a text object, up to four corner handles are visualized. The amount of handles and their behavior depends on the vertical and horizontal alignment of the text, and on whether the handles are being translated or reshaped.

  • TRANSLATED: If the interior of the text bounds are touched, the whole shape is translated. If a corner handle is translated, it stretches and rotates the shape starting from an anchor point determined by the alignment. The images below illustrate the editing behavior when the text is aligned to the left and the bottom. The small black arrow indicates the path of the mouse cursor while translating the bounds.

    Moving the whole shape
    		Moving a corner point
    Moving a corner point.
    		Moving the interior.
  • RESHAPED: The reshaping behavior allows stretching the shape by dragging one of its edges, starting from an anchor point determined by the alignment. When touching a corner point, the behavior is identical as with the TRANSLATED mode. The images below illustrate the editing behavior when the text is aligned to the left and the bottom. The small black arrow indicates the path of the mouse cursor while reshaping the bounds.

    Moving a corner point
    		Moving a frame edge
    Moving a corner point.
    		Moving a frame edge.

Initializing an ILcd2DEditableText

When initializing a text via interaction through the view, a number of user interactions are required to complete the initialization. This number depends on the creation mode and it is either 1 or 3 for the modes ONE_CLICK or THREE_CLICK.

Whenever the text string of the ILcdText object needs to be edited, the protected method getText is called. Overwrite this method to customize the editing of the text string. By default the class TLcdUserDialog is used to pop up an input dialog.

Accepted snap targets

This painter does not support snapping.

Additional properties

If either the width or the height of the text is 0, it will be painted using the original, unscaled font.

See Also:

  • Field Details

    • LEFT_BOTTOM

      protected static final int LEFT_BOTTOM
      Constant value denoting the left bottom corner point of the text.
      See Also:

    • LEFT_TOP

      protected static final int LEFT_TOP
      Constant value denoting the left top corner point of the text.
      See Also:

    • RIGHT_TOP

      protected static final int RIGHT_TOP
      Constant value denoting the right top corner point of the text.
      See Also:

    • RIGHT_BOTTOM

      protected static final int RIGHT_BOTTOM
      Constant value denoting the right bottom corner point of the text.
      See Also:

    • ONE_CLICK

      public static final int ONE_CLICK
      Constant for the one click creation mode. The click defines the location point of the ILcdText object. The initial width and height of the text are defined by the properties startLetterWidth and startTextHeight.
      See Also:

    • THREE_CLICK

      public static final int THREE_CLICK
      Constant for the three click creation mode. The clicks define:
      1. the position of the location point,
      2. the rotation angle of the text, and
      3. the width and height of the text.
      See Also:

    • cursorTranslating

      public static volatile Cursor cursorTranslating
      The cursor shown when translating a text.

    • cursorReshaping

      public static Cursor cursorReshaping
      The cursor shown when reshaping a text.

    • cursorResizing

      public static Cursor[] cursorResizing
      The cursors shown when resizing a text. Cursors are sorted per direction in which resizing is done, starting from east, going anti clock wise. The last entry is the same as the first entry.

  • Constructor Details

    • TLcdGXYTextPainter

      public TLcdGXYTextPainter()
      Constructs a default TLcdGXYTextPainter and sets the display name to "Text".

  • Method Details

    • setObject

      public void setObject(Object aObject)

      Sets the object to paint and edit. The object should be an instance of ILcdText for painting and an instance of ILcd2DEditableText for editing.

      This painter/editor can be used to paint the object without using the edit functionality. This method shall therefore only check if the object implements ILcdText and shall throw a ClassCastException if it does not.

      When this painter is used as editor with an object that does not implement the interface ILcd2DEditableText, the edit method shall throw the necessary exception.

      Specified by:
      setObject in interface ILcdGXYEditor
      Specified by:
      setObject in interface ILcdGXYPainter
      Parameters:
      aObject - The object to paint and edit.
      Throws:
      ClassCastException - when the object does not implement ILcdText.
      See Also:

    • getObject

      public final Object getObject()
      Returns the object that can currently be painted or edited by this painter/editor.
      Specified by:
      getObject in interface ILcdGXYEditor
      Specified by:
      getObject in interface ILcdGXYPainter
      Returns:
      the object that can currently be painted or edited by this painter/editor.
      See Also:

    • setCreationMode

      public void setCreationMode(int aCreationMode)
      Sets the mode to decide how to create an ILcdText object. A text can be created in the following modes. The default value is ONE_CLICK.
      • ONE_CLICK, which enables setting the location point,
      • THREE_CLICK, which enables setting the location point, the rotation angle, and the width and height of the text.
      Parameters:
      aCreationMode - The mode deciding how to create an ILcdText object.

    • setStartTextHeight

      public static void setStartTextHeight(int aStartTextHeight)
      Sets the start height defined in pixels of the text when created in ONE_CLICK mode. The default value of this property is 20.
      Parameters:
      aStartTextHeight - the height of text when created in ONE_CLICK mode.

    • setStartLetterWidth

      public static void setStartLetterWidth(int aStartLetterWidth)
      Sets the start width defined in pixels of the letters when created in ONE_CLICK mode. The default value of this property is 20.
      Parameters:
      aStartLetterWidth - the width of the letters when created in ONE_CLICK mode.

    • setFramed

      public void setFramed(boolean aFramed)
      Sets whether a frame should be painted around the text or not. By default, no frame will be displayed, the value is false.
      Parameters:
      aFramed - A flag indicating whether a frame should be painted around the text or not.
      See Also:

    • isFramed

      public boolean isFramed()
      Returns whether a frame should be painted around the text.
      Returns:
      whether a frame should be painted around the text.
      See Also:

    • setFramedWhenSelected

      public void setFramedWhenSelected(boolean aFramedWhenSelected)
      Sets whether a frame should be painted around the text when it is painted in selected mode or not. By default, no frame will be displayed, the value is false.
      Parameters:
      aFramedWhenSelected - A flag indicating whether a frame should be painted around the text when it is painted in selected mode or not.
      See Also:

    • isFramedWhenSelected

      public boolean isFramedWhenSelected()
      Returns whether a frame should be painted around the text when it is painted in selected mode.
      Returns:
      whether a frame should be painted around the text when it is painted in selected mode.
      See Also:

    • setFitTextInArea

      public void setFitTextInArea(boolean aFitTextInArea)
      Sets whether the text should be stretched to fit in its area, regardless of font.

      By default, the text is not stretched, the value is false.

      If set, the text will be stretched such that the displayed text is as wide as ILcdText.getTextWidth(), so based on character width x text length. This may cause the letters' aspect to change.

      Parameters:
      aFitTextInArea - A flag indicating whether the text should be stretched to fit in its area.
      See Also:

    • isFitTextInArea

      public boolean isFitTextInArea()
      Returns whether the text should be stretched to fit in its area, regardless of font.
      Returns:
      whether the text should be stretched to fit in its area, regardless of font.
      See Also:

    • setFilled

      public void setFilled(boolean aFilled)
      Sets whether the text should be painted in a filled background or not. The default setting of this property is false.
      Parameters:
      aFilled - A flag indicating whether the text should be painted in a filled background or not.
      See Also:

    • isFilled

      public boolean isFilled()
      Returns whether the text should be painted in a filled background.
      Returns:
      whether the text should be painted in a filled background.
      See Also:

    • setMargin

      public void setMargin(int aMargin)

      Sets the number of pixels of the margin that will be used around the ILcdText object for drawing the handles, the frame, the filled background,...

      The default value of this property is 2 pixels. Note that negative values are not allowed and are converted to 0.

      Parameters:
      aMargin - the number of pixels of the margin around the ILcdText object.
      See Also:

    • getMargin

      public int getMargin()
      Returns the number of pixels of the margin used around the ILcdText object.
      Returns:
      the number of pixels of the margin used around the ILcdText object.
      See Also:

    • setSnapToInvisiblePoints

      public void setSnapToInvisiblePoints(boolean aSnapToInvisiblePoints)
      Sets whether the other shapes can snap to invisible points of this shape. Note that this painter does not support snapping, the property will therefore not be taken into account. The default value is false.
      Parameters:
      aSnapToInvisiblePoints - A flag indicating whether snapping to the invisible points is allowed.
      See Also:

    • isSnapToInvisiblePoints

      public boolean isSnapToInvisiblePoints()
      Returns whether the painter allows snapping to the invisible points of the shape.
      Returns:
      whether the painter allows snapping to the invisible points of the shape.
      See Also:

    • setFontStyle

      public void setFontStyle(ILcdGXYPainterStyle aFontStyle)
      Sets the style that will be used to paint the ILcdText object.
      Parameters:
      aFontStyle - the style used to paint the ILcdText object.
      See Also:

    • getFontStyle

      public ILcdGXYPainterStyle getFontStyle()
      Returns the style used to paint the ILcdText object.
      Returns:
      the style used to paint the ILcdText object.
      See Also:

    • setFrameStyle

      public void setFrameStyle(ILcdGXYPainterStyle aFrameStyle)
      Sets the style that will be used to paint the frame around the ILcdText object.
      Parameters:
      aFrameStyle - the style used to paint the frame around the ILcdText object.
      See Also:

    • getFrameStyle

      public ILcdGXYPainterStyle getFrameStyle()
      Returns the style used to paint the frame around the ILcdText object.
      Returns:
      the style used to paint the frame around the ILcdText object.
      See Also:

    • setFillStyle

      public void setFillStyle(ILcdGXYPainterStyle aFillStyle)
      Sets the style that will be used to fill the background of the ILcdText object.
      Parameters:
      aFillStyle - the style used to fill the background of the ILcdText object.
      See Also:

    • getFillStyle

      public ILcdGXYPainterStyle getFillStyle()
      Returns the style used to fill the background of the ILcdText object.
      Returns:
      the style used to fill the background of the ILcdText object.
      See Also:

    • setSnapIcon

      public void setSnapIcon(ILcdIcon aSnapIcon)
      Sets the icon that marks snap targets of the object currently set to this painter. This icon is painted when the paint method is called with the render mode ILcdGXYPainter.SNAPS.
      Parameters:
      aSnapIcon - The icon that should be used to paint snap target points.
      See Also:

    • getSnapIcon

      public ILcdIcon getSnapIcon()
      Returns the icon that is used to paint snap target points of the object set to this painter.
      Returns:
      the icon that is used to paint snap target points of the object set to this painter.
      See Also:

    • setupGraphicsForText

      protected void setupGraphicsForText(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext)

      Called just before drawing the text on the specified Graphics object. It can be redefined in order to set specific Graphics properties like Color, etc...

      This implementation calls ILcdGXYPainterStyle.setupGraphics(java.awt.Graphics, java.lang.Object, int, com.luciad.view.gxy.ILcdGXYContext) on the fontStyle property if a font style has been set to this instance.

      Parameters:
      aGraphics - The graphics to paint the object on.
      aRenderMode - The mode to render the object in.
      aGXYContext - The context to render the object in.

    • setupGraphicsForFrame

      protected void setupGraphicsForFrame(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext)

      Called just before painting the frame on the specified Graphics object. It can be redefined in order to set specific Graphics properties like Color, etc...

      This implementation calls ILcdGXYPainterStyle.setupGraphics(java.awt.Graphics, java.lang.Object, int, com.luciad.view.gxy.ILcdGXYContext) on the frameStyle property if a frame style has been set to this instance.

      Parameters:
      aGraphics - The graphics to paint the object on.
      aRenderMode - The mode to render the object in.
      aGXYContext - The context to render the object in.

    • setupGraphicsForFill

      protected void setupGraphicsForFill(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext)

      Called just before filling the backgrounds on the specified Graphics object. It can be redefined in order to set specific Graphics properties like Color, etc...

      This implementation calls ILcdGXYPainterStyle.setupGraphics(java.awt.Graphics, java.lang.Object, int, com.luciad.view.gxy.ILcdGXYContext) on the fillStyle property if a fill style has been set to this instance.

      Parameters:
      aGraphics - The graphics to paint the object on.
      aRenderMode - The mode to render the object in.
      aGXYContext - The context to render the object in.

    • getCursor

      public Cursor getCursor(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext)
      Returns a Cursor that clarifies the render mode and context this painter is operating in. When no specific Cursor is required, null is returned.
      Specified by:
      getCursor in interface ILcdGXYPainter
      Overrides:
      getCursor in class ALcdGXYPainter
      Parameters:
      aGraphics - The graphics on which the object is painted.
      aRenderMode - The mode to render the object in.
      aGXYContext - The context in which the object is rendered.
      Returns:
      a cursor to indicate the type of operating mode and context. Returns null if no particular cursor is required.

    • boundsSFCT

      public void boundsSFCT(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext, ILcd2DEditableBounds aBoundsSFCT) throws TLcdNoBoundsException
      Computes the bounds of the representation of an ILcdText in AWT coordinates. The bounds will include the four corner point of the text.
      Specified by:
      boundsSFCT in interface ILcdGXYPainter
      Parameters:
      aGraphics - The graphics to paint the object on.
      aRenderMode - The mode to render the object in.
      aGXYContext - The context to render the object in.
      aBoundsSFCT - The bounds to update.
      Throws:
      TLcdNoBoundsException - if no bounds can be determined for the representation of the object. This can be when the object does not have a representation in the given context, for example when it is located in a part of the world which is not visible in the projection as set in the views world reference.
      See Also:

    • isTouched

      public boolean isTouched(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext)
      Depending on the rendering mode, returns whether the mouse pointer is within the rotated bounds of the ILcdText object.
      Specified by:
      isTouched in interface ILcdGXYPainter
      Parameters:
      aGraphics - The graphics to paint the object on.
      aRenderMode - The mode to render the object in.
      aGXYContext - The context in which the object is rendered.
      Returns:
      whether the mouse pointer is within the bounds of the ILcdText object.
      See Also:

    • paint

      public void paint(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext)
      Displays the representation of the object in the given mode on the Graphics passed, taking into account the context passed.
      Specified by:
      paint in interface ILcdGXYPainter
      Parameters:
      aGraphics - The graphics to paint the object on.
      aRenderMode - The mode to render the object in.
      aGXYContext - The context to render the object in.

    • getGXYEditor

      public ILcdGXYEditor getGXYEditor(Object aObject)
      Returns this instance as editor for editing the specified Object. If this Object is not the same as the Object set to this painter, the setObject(Object) method is called to update the object set to the painter.
      Specified by:
      getGXYEditor in interface ILcdGXYEditorProvider
      Parameters:
      aObject - the object to be edited.
      Returns:
      this instance as editor for editing the specified Object.

    • getCreationClickCount

      public int getCreationClickCount()
      Returns either 1 or 3 depending on the creation mode (ONE_CLICK or THREE_CLICK) as the number of required user interactions.
      Specified by:
      getCreationClickCount in interface ILcdGXYEditor
      Returns:
      either 1 or 3 depending on the creation mode.
      See Also:

    • edit

      public boolean edit(Graphics aGraphics, int aRenderMode, ILcdGXYContext aGXYContext)

      This implementation edits the ILcdText object set to the painter. The object needs to implement the interface ILcd2DEditableText otherwise a ClassCastException will be thrown.

      In ILcdGXYEditor.TRANSLATED render mode, the ILcdText object is edited as follows:

      • While touching a corner point, the corner point gets translated. This will change the width, height and rotation angle of the text.
      • While touching the frame, the object gets translated as a whole.
      • While touching the interior, the object gets translated as a whole.

      In ILcdGXYEditor.RESHAPED render mode, the ILcdText object is edited as follows:

      • While touching a corner point, the corner point will move and the width, the height and the rotation angle will be updated.
      • While touching the upper or right edge, the edge line will move while enlarging or reducing the width or height of the text.

      The creation render mode behavior is defined by the creation mode. Further changes have to be done within edition mode.

      • In the ONE_CLICK mode, that point will determine the location point of the text. The initial width and height of the text are defined by the properties startLetterWidth and startTextHeight.
      • In the THREE_CLICK mode, the first point determines the location point of the text, the second the rotation angle and the third the width and height of the text.

      Note that this painter does not support snapping.

      Specified by:
      edit in interface ILcdGXYEditor
      Parameters:
      aGraphics - The graphics to edit the object on.
      aRenderMode - The mode to render the object in.
      aGXYContext - The context to render the object in.
      Returns:
      true if the object has changed when this method returns, false otherwise.
      Throws:
      ClassCastException - if the painter's object does not implement ILcd2DEditableText.
      See Also:

    • getText

      protected void getText(ILcdGXYContext aGXYContext, ILcd2DEditableText aTextSFCT)
      Gets a new text for the ILcd2DEditableText object. The default implementation uses the com.luciad.gui.TLcdUserDialog class to popup an input dialog.
      Overwrite this method to customize the edition of the text object.
      Parameters:
      aGXYContext - the context in which to create the text.
      aTextSFCT - the ILcd2DEditableText for which the text will be set.
      See Also:

    • linkToSnapTarget

      protected boolean linkToSnapTarget(Graphics aGraphics, ILcd2DEditableText aTextSFCT, int aTouchedCorner, ILcdGXYContext aGXYContext)
      Sets the specified corner point at the given snap target, if the snap target is accepted. The corner index should be is one of the predefined constants (LEFT_BOTTOM, LEFT_TOP,RIGHT_BOTTOM,RIGHT_TOP). Note that this painter does not support snapping, this implementation is therefore empty.
      Parameters:
      aGraphics - The graphics to paint the object on.
      aTextSFCT - The bounds objects to be edited.
      aTouchedCorner - The corner index to set at the snap target.
      aGXYContext - The context to render the object in.
      Returns:
      whether the corner was successfully linked to the snap target.
      See Also:

    • supportSnap

      public boolean supportSnap(Graphics aGraphics, ILcdGXYContext aGXYContext)
      This implementation does not support snapping, always returns false.
      Specified by:
      supportSnap in interface ILcdGXYPainter
      Overrides:
      supportSnap in class ALcdGXYPainter
      Parameters:
      aGraphics - the graphics on which is worked.
      aGXYContext - the context of the snapping.
      Returns:
      false.

    • snapTarget

      public Object snapTarget(Graphics aGraphics, ILcdGXYContext aGXYContext)
      Returns null because snapping is not supported.
      Specified by:
      snapTarget in interface ILcdGXYPainter
      Overrides:
      snapTarget in class ALcdGXYPainter
      Parameters:
      aGraphics - the graphics on which is worked.
      aGXYContext - the context of the snapping.
      Returns:
      null.
      See Also:

    • setModelModelTransformationClass

      public void setModelModelTransformationClass(Class aModel2ModelTransformationClass)
      Empty implementation because snapping is not supported.
      Parameters:
      aModel2ModelTransformationClass - not taken into account.

    • acceptSnapTarget

      public boolean acceptSnapTarget(Graphics aGraphics, ILcdGXYContext aGXYContext)
      Returns false because snapping is not supported.
      Specified by:
      acceptSnapTarget in interface ILcdGXYEditor
      Parameters:
      aGraphics - the Graphics on which the snap target should be checked.
      aGXYContext - the context in which the snap target should be checked.
      Returns:
      false.
      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 ILcdGXYEditorProvider
      Specified by:
      clone in interface ILcdGXYPainterProvider
      Overrides:
      clone in class ALcdGXYPainter
      Returns:
      a clone of this painter provider.
      See Also: