CharacterMarkerSymbol

java.lang.Object
- org.gvsig.labeling.symbol.CharacterMarkerSymbol

All Implemented Interfaces:

Cloneable, CartographicSupport, IPrintable, ISymbol, IMarkerSymbol, Persistent
```
public class CharacterMarkerSymbol
extends Object
implements IMarkerSymbol
```
Allows to use a source of TrueType characters to define the marker that will substitute the symbol.If the picture is defined in a source, the performance is more agile.

Field Summary

Fields
Modifier and Type Field and Description

static String CHARACTER_MARKER_SYMBOL_PERSISTENCE_NAME
- Fields inherited from interface org.gvsig.symbology.fmap.mapcontext.rendering.symbol.marker.IMarkerSymbol
  CIRCLE_STYLE, CROSS_STYLE, DIAMOND_STYLE, SQUARE_STYLE, STAR_STYLE, SYMBOL_NAME, TRIANGLE_STYLE, VERTICAL_LINE_STYLE, X_STYLE
- Fields inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol
  SELECTION_COLOR
- Fields inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.CartographicSupport
  PAPER, WORLD

Fields
Modifier and Type	Field and Description
`static String`	`CHARACTER_MARKER_SYMBOL_PERSISTENCE_NAME`

Constructor Summary

Constructors
Constructor and Description
`CharacterMarkerSymbol()` Creates a new instance of CharacterMarker with default values
`CharacterMarkerSymbol(Font font, int charCode, Color color)` Creates a new instance of CharacterMarker specifying the marker source font, the character code corresponding to the symbol, and the color that will be used in rendering time.

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`clone()` Creates a copy of the object.
`void`	`draw(Graphics2D g, AffineTransform affineTransform, Geometry geom, Feature feat, Cancellable cancel)` Used when a symbol is going to be drawn.The method to do it will depend on the derived version of the symbol.
`void`	`drawInsideRectangle(Graphics2D g, AffineTransform scaleInstance, Rectangle r, PrintAttributes properties)` Useful to render the symbol inside the TOC, or inside little rectangles.
`double`	`getCartographicSize(ViewPort viewPort, double dpi, Geometry geom)` Gets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).
`Color`	`getColor()` Returns the color of the marker symbol.
`String`	`getDescription()` The description is a human-readable text used to label it when show in a symbol menu or something like that.
`Font`	`getFont()` Returns the font that will be used to define the symbol
`IMask`	`getMask()`
`Point2D`	`getOffset()` Gets the offset for a marker symbol
`int`	`getOnePointRgb()` Returns the rgb of the symbol when it is drawn like a point.
`void`	`getPixExtentPlus(Geometry geom, float[] distances, ViewPort viewPort, int dpi)` Returns the distance between the shape's bounding box and the symbol-that-represents-this-shape's bounding box in a two-length-float array passed as parameter.
`int`	`getReferenceSystem()` Returns the Reference System used to draw the elements of the image.
`double`	`getRotation()` Returns the rotation (in radians, counter-clockwise) of the marker symbol
`double`	`getSize()` Obtains the size of a marker symbol
`ISymbol`	`getSymbolForSelection()` Returns the derived version of the symbol that will be used to draw the feature when it is selected.
`int`	`getSymbolType()` The use of this method -and its mechanism- is being valorated.
`int`	`getUnicode()` Obtains the unicode for a symbol
`int`	`getUnit()` Returns the unit used to express measures.
`boolean`	`isOneDotOrPixel(Geometry geom, double[] positionOfDotOrPixel, ViewPort viewPort, int dpi)` Informs that the geometry will be represented with that symbol in just one pixel or dot
`boolean`	`isShapeVisible()` Tells whether the shape of the symbol will be drawn or not.
`boolean`	`isSuitableFor(Geometry geom)` True if this symbol is ok for the geometry.
`boolean`	`isVisuallyCorrected()` Returns true of false depending if the character marker symbol selected is visually corrected.That is, if the character has been properly scaled to use a specific number of pixels to be represented.
`void`	`loadFromState(PersistentState state)` Set the state of the object from the state passed as parameter.
`void`	`print(Graphics2D g, AffineTransform at, Geometry geom, PrintAttributes properties)`
`static void`	`registerPersistent()`
`void`	`saveToState(PersistentState state)` Saves the internal state of the object on the provided PersistentState object.
`void`	`setAlpha(int a)` Defines the transparency of a line symbol.
`void`	`setCartographicSize(double cartographicSize, Geometry geom)` Sets the size of the cartographic element in pixels.
`void`	`setColor(Color co)` Establishes a color for the marker symbol
`void`	`setDescription(String d)` Sets the description of this symbol
`void`	`setFont(Font font)` Sets the font that will be used to define the symbol
`void`	`setMask(IMask m)` Defines a mask for the symbol
`void`	`setOffset(Point2D off)` Establishes the offset currently set for the marker symbol.
`void`	`setReferenceSystem(int rs)` Sets the Reference System that defines how this units have to be handled.
`void`	`setRotation(double rot)` Sets the rotation of the marker symbol
`void`	`setSize(double size)` Sets the size of marker symbol
`void`	`setUnicode(int symbol)` Sets the unicode for a symbol represented by a character
`void`	`setUnit(int unitIndex)` Defines the unit used to express measures.
`void`	`setVisuallyCorrected(boolean visuallyCorrected)` Sets the visual correction for a character in order to scale it if it is necessary.
`double`	`toCartographicSize(ViewPort viewPort, double dpi, Geometry geom)` Computes and sets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CHARACTER_MARKER_SYMBOL_PERSISTENCE_NAME
```
public static final String CHARACTER_MARKER_SYMBOL_PERSISTENCE_NAME
```
    See Also:
    Constant Field Values
- Constructor Detail
  - CharacterMarkerSymbol
```
public CharacterMarkerSymbol()
```
    Creates a new instance of CharacterMarker with default values
  - CharacterMarkerSymbol
```
public CharacterMarkerSymbol(Font font,
                     int charCode,
                     Color color)
```
    Creates a new instance of CharacterMarker specifying the marker source font, the character code corresponding to the symbol, and the color that will be used in rendering time.
    
    Parameters:
    font - - src Font
    charCode - - character code of the symbol for this font
    color - - color to be used in when rendering.
- Method Detail
  - getFont
```
public Font getFont()
```
    Returns the font that will be used to define the symbol
    
    Returns:
    font
  - setFont
```
public void setFont(Font font)
```
    Sets the font that will be used to define the symbol
  - getSymbolForSelection
```
public ISymbol getSymbolForSelection()
```
    Description copied from interface: ISymbol
    
    Returns the derived version of the symbol that will be used to draw the feature when it is selected.
    
    Specified by:
    
    getSymbolForSelection in interface ISymbol
    
    Returns:
    ISymbol applied to a feature when it has been selected.
  - draw
```
public void draw(Graphics2D g,
        AffineTransform affineTransform,
        Geometry geom,
        Feature feat,
        Cancellable cancel)
```
    Description copied from interface: ISymbol
    
    Used when a symbol is going to be drawn.The method to do it will depend on the derived version of the symbol.
    
    Specified by:
    
    draw in interface ISymbol
    
    cancel - TODO
  - setUnicode
```
public void setUnicode(int symbol)
```
    Sets the unicode for a symbol represented by a character
    
    Parameters:
    symbol, - int
  - getUnicode
```
public int getUnicode()
```
    Obtains the unicode for a symbol
    
    Returns:
    unicode, int
  - getSize
```
public double getSize()
```
    Description copied from interface: IMarkerSymbol
    
    Obtains the size of a marker symbol
    
    Specified by:
    
    getSize in interface IMarkerSymbol
  - setSize
```
public void setSize(double size)
```
    Description copied from interface: IMarkerSymbol
    
    Sets the size of marker symbol
    
    Specified by:
    
    setSize in interface IMarkerSymbol
  - isVisuallyCorrected
```
public boolean isVisuallyCorrected()
```
    Returns true of false depending if the character marker symbol selected is visually corrected.That is, if the character has been properly scaled to use a specific number of pixels to be represented.
    
    Returns:
    boolean
  - setVisuallyCorrected
```
public void setVisuallyCorrected(boolean visuallyCorrected)
```
    Sets the visual correction for a character in order to scale it if it is necessary.
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Description copied from interface: Cloneable
    
    Creates a copy of the object.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    a copy of the object
    
    Throws:
    
    CloneNotSupportedException - if the instance of the object cannot be cloned. As this is extending Cloneable so its sure it implements it, so this exception may be used for problems on specific object instances.
    See Also:
    Object#clone()}.
  - getPixExtentPlus
```
public void getPixExtentPlus(Geometry geom,
                    float[] distances,
                    ViewPort viewPort,
                    int dpi)
```
    Description copied from interface: ISymbol
    Returns the distance between the shape's bounding box and the symbol-that-represents-this-shape's bounding box in a two-length-float array passed as parameter.
    
    After this method returns, the float array passed will contain two values representing the amount of pixels separating each of the X (first element) and Y (second element) axes.
    
    This distance maybe dependent on:
    1. The ViewPort: if the symbol is an instance of CartographicSupport the units it uses are not pixels and the reference system is CarthographicSupport.WORLD.
    2. The target rendering context's dpi (dots-per-inch): if the symbol is an instance of CartographicSupport the units it uses are not pixels and CarthographicSupport.PAPER.
    And in any other case, if the unit of the symbol is pixels or the symbol is not even an instance of CartographicSupport, the returning values are only defined by the symbol and are not calculated.
    Specified by:
    
    getPixExtentPlus in interface ISymbol
  - isOneDotOrPixel
```
public boolean isOneDotOrPixel(Geometry geom,
                      double[] positionOfDotOrPixel,
                      ViewPort viewPort,
                      int dpi)
```
    Description copied from interface: ISymbol
    
    Informs that the geometry will be represented with that symbol in just one pixel or dot
    
    Specified by:
    
    isOneDotOrPixel in interface ISymbol
    
    positionOfDotOrPixel - (out) filled with pixel or dot location
    
    Returns:
  - getOnePointRgb
```
public int getOnePointRgb()
```
    Description copied from interface: ISymbol
    
    Returns the rgb of the symbol when it is drawn like a point.
    
    Specified by:
    
    getOnePointRgb in interface ISymbol
    
    Returns:
    rgb of the symbol.
  - getDescription
```
public String getDescription()
```
    Description copied from interface: ISymbol
    
    The description is a human-readable text used to label it when show in a symbol menu or something like that.
    
    Specified by:
    
    getDescription in interface ISymbol
    
    Returns:
    description of this symbol.
  - isShapeVisible
```
public boolean isShapeVisible()
```
    Description copied from interface: ISymbol
    
    Tells whether the shape of the symbol will be drawn or not.
    
    Specified by:
    
    isShapeVisible in interface ISymbol
    
    Returns:
    true if Shape must be drawn. Useful if you are labelling
  - setDescription
```
public void setDescription(String d)
```
    Description copied from interface: ISymbol
    
    Sets the description of this symbol
    
    Specified by:
    
    setDescription in interface ISymbol
    
    See Also:
    ISymbol.getDescription();
  - getSymbolType
```
public int getSymbolType()
```
    Description copied from interface: ISymbol
    
    The use of this method -and its mechanism- is being valorated. It probably will be deprecated.
    
    Specified by:
    
    getSymbolType in interface ISymbol
    
    Returns:
    FSymbol constants. I think it is better to use isSuitableFor
  - isSuitableFor
```
public boolean isSuitableFor(Geometry geom)
```
    Description copied from interface: ISymbol
    
    True if this symbol is ok for the geometry. For example, a FillSymbol will be suitable for a Polygon.
    
    Specified by:
    
    isSuitableFor in interface ISymbol
    
    Returns:
  - drawInsideRectangle
```
public void drawInsideRectangle(Graphics2D g,
                       AffineTransform scaleInstance,
                       Rectangle r,
                       PrintAttributes properties)
                         throws SymbolDrawingException
```
    Description copied from interface: ISymbol
    
    Useful to render the symbol inside the TOC, or inside little rectangles. For example, think about rendering a Label with size in meters => You will need to specify a size in pixels. Of course, you can also to choose to render a prepared image, etc.
    
    Specified by:
    
    drawInsideRectangle in interface ISymbol
    
    properties - TODO
    
    Throws:
    
    SymbolDrawingException - TODO
  - print
```
public void print(Graphics2D g,
         AffineTransform at,
         Geometry geom,
         PrintAttributes properties)
```
    Specified by:
    
    print in interface IPrintable
  - setUnit
```
public void setUnit(int unitIndex)
```
    Description copied from interface: CartographicSupport
    
    Defines the unit used to express measures. It is the position of the unit in the MapContext.NAMES array.
    
    Specified by:
    
    setUnit in interface CartographicSupport
  - getUnit
```
public int getUnit()
```
    Description copied from interface: CartographicSupport
    
    Returns the unit used to express measures. It is the position of the unit in the MapContext.NAMES array.
    
    Specified by:
    
    getUnit in interface CartographicSupport
  - getReferenceSystem
```
public int getReferenceSystem()
```
    Description copied from interface: CartographicSupport
    
    Returns the Reference System used to draw the elements of the image.
    
    The elements have to be scaled to pixel when the image is bein drawn in order to compose the map. The elements of the map may define its size in other units than pixel.
    
    CartographicSupport enables the elements to define the size in measure units but these units may refer to different reference system. Two kinds of Reference Systems are allowed in this context: CartographicSupport.WORLD, and CartographicSupport.PAPER.
    
    Depending on which Reference System is used the unit used by this element refers to distances in the real world (then they are map's CRS-dependant) or screen or printer output (then they are output DPI-dependant)
    
    In case the unit used is pixel then the reference system does not have any effect since the source unit is the same than the target unit.
    
    Specified by:
    
    getReferenceSystem in interface CartographicSupport
    
    Returns:
  - setReferenceSystem
```
public void setReferenceSystem(int rs)
```
    Description copied from interface: CartographicSupport
    Sets the Reference System that defines how this units have to be handled. Possible values are:
    1. CartographySupport.WORLD: Defines that the unit values refer to distances in the world. So, the size of the element displayed depends directly on the scale and CRS used by the map. The size of the elements defined to use CartographicSupport.WORLD will match exactly to their actual size in the real world.
    2. CartographySupport.PAPER: Defines that the unit values refer to the length that the element will have regardless where it appears. If ReferenceSystem is CartographySupport.PAPER, and the length is (e.g.) millimeters the element will be displayed with the same amount of millimeters of length whether in the screen or the printer (screen DPI and printer DPI must be correctly configured).
    Specified by:
    
    setReferenceSystem in interface CartographicSupport
  - toCartographicSize
```
public double toCartographicSize(ViewPort viewPort,
                        double dpi,
                        Geometry geom)
```
    Description copied from interface: CartographicSupport
    
    Computes and sets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).
    
    Specified by:
    
    toCartographicSize in interface CartographicSupport
    
    Returns:
    a double containing the previous defined size
  - setCartographicSize
```
public void setCartographicSize(double cartographicSize,
                       Geometry geom)
```
    Description copied from interface: CartographicSupport
    
    Sets the size of the cartographic element in pixels.
    
    Specified by:
    
    setCartographicSize in interface CartographicSupport
  - getCartographicSize
```
public double getCartographicSize(ViewPort viewPort,
                         double dpi,
                         Geometry geom)
```
    Description copied from interface: CartographicSupport
    
    Gets the size (in pixels) of the cartographic element according to the current rendering context (output dpi, map scale, map units) and the symbol cartgraphic settings (unit, size, and unit reference system).
    
    Specified by:
    
    getCartographicSize in interface CartographicSupport
    
    Returns:
    double containing the size in [screen/printer] pixels for the current symbol
  - getRotation
```
public double getRotation()
```
    Description copied from interface: IMarkerSymbol
    
    Returns the rotation (in radians, counter-clockwise) of the marker symbol
    
    Specified by:
    
    getRotation in interface IMarkerSymbol
    
    Returns:
    double (rotation)
  - setRotation
```
public void setRotation(double rot)
```
    Description copied from interface: IMarkerSymbol
    
    Sets the rotation of the marker symbol
    
    Specified by:
    
    setRotation in interface IMarkerSymbol
  - getOffset
```
public Point2D getOffset()
```
    Description copied from interface: IMarkerSymbol
    
    Gets the offset for a marker symbol
    
    Specified by:
    
    getOffset in interface IMarkerSymbol
    
    Returns:
    Point2D
  - setOffset
```
public void setOffset(Point2D off)
```
    Description copied from interface: IMarkerSymbol
    
    Establishes the offset currently set for the marker symbol.
    
    Specified by:
    
    setOffset in interface IMarkerSymbol
  - getColor
```
public Color getColor()
```
    Description copied from interface: IMarkerSymbol
    
    Returns the color of the marker symbol.
    
    Specified by:
    
    getColor in interface ISymbol
    
    Specified by:
    
    getColor in interface IMarkerSymbol
    
    Returns:
    Color
  - setColor
```
public void setColor(Color co)
```
    Description copied from interface: IMarkerSymbol
    
    Establishes a color for the marker symbol
    
    Specified by:
    
    setColor in interface ISymbol
    
    Specified by:
    
    setColor in interface IMarkerSymbol
    
    Parameters:
    co - to render the symbol
  - setAlpha
```
public void setAlpha(int a)
```
    Description copied from interface: IMarkerSymbol
    
    Defines the transparency of a line symbol.
    
    Specified by:
    
    setAlpha in interface IMarkerSymbol
  - getMask
```
public IMask getMask()
```
    Specified by:
    
    getMask in interface IMarkerSymbol
    
    Returns:
    the mask of the symbol
  - setMask
```
public void setMask(IMask m)
```
    Description copied from interface: IMarkerSymbol
    
    Defines a mask for the symbol
    
    Specified by:
    
    setMask in interface IMarkerSymbol
  - loadFromState
```
public void loadFromState(PersistentState state)
                   throws PersistenceException
```
    Description copied from interface: Persistent
    
    Set the state of the object from the state passed as parameter.
    
    Specified by:
    
    loadFromState in interface Persistent
    
    Throws:
    
    PersistenceException
  - saveToState
```
public void saveToState(PersistentState state)
                 throws PersistenceException
```
    Description copied from interface: Persistent
    
    Saves the internal state of the object on the provided PersistentState object.
    
    Specified by:
    
    saveToState in interface Persistent
    
    Throws:
    
    PersistenceException
  - registerPersistent
```
public static void registerPersistent()
```

Class CharacterMarkerSymbol

Field Summary

Fields inherited from interface org.gvsig.symbology.fmap.mapcontext.rendering.symbol.marker.IMarkerSymbol

Fields inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol

Fields inherited from interface org.gvsig.fmap.mapcontext.rendering.symbols.CartographicSupport

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CHARACTER_MARKER_SYMBOL_PERSISTENCE_NAME

Constructor Detail

CharacterMarkerSymbol

CharacterMarkerSymbol

Method Detail

getFont

setFont

getSymbolForSelection

draw

setUnicode

getUnicode

getSize

setSize

isVisuallyCorrected

setVisuallyCorrected

clone

getPixExtentPlus

isOneDotOrPixel

getOnePointRgb

getDescription

isShapeVisible

setDescription

getSymbolType

isSuitableFor

drawInsideRectangle

print

setUnit

getUnit

getReferenceSystem

setReferenceSystem

toCartographicSize

setCartographicSize

getCartographicSize

getRotation

setRotation

getOffset

setOffset

getColor

setColor

setAlpha

getMask

setMask

loadFromState

saveToState

registerPersistent