IlvMapPointRenderingStyle (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.maps.rendering.IlvMapRenderingStyle
- - ilog.views.maps.rendering.IlvMapPointRenderingStyle

All Implemented Interfaces:

IlvPersistentObject, Serializable
```
public class IlvMapPointRenderingStyle
extends IlvMapRenderingStyle
```
This rendering style stores style parameters to render the points. This class is to be used with an IlvDefaultPointRenderer. Two sets of parameters are stored in this style: a set to customize an IlvMarker for which you can specify marker type size and color, and a set to customize an IlvFontMarker for which you can specify a character, a font, an antialiasing mode, a fill paint, a stroke paint, and a rotation angle.

Since:

JViews 5.0

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`IlvMapPointRenderingStyle()` Constructs a new `IlvMapPointRenderingStyle` with the defaults parameters values.
`IlvMapPointRenderingStyle(IlvInputStream stream)` Reads a `IlvMapPointRenderingStyle` from an `IlvInputStream`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`char`	`getChar()` Retrieves the character used to render a point.
`Paint`	`getFillPaint()` Retrieves the fill paint used to fill the character.
`Font`	`getFont()` Retrieves the font used to render a point.
`Color`	`getMarkerColor()` Retrieves the marker color.
`int`	`getMarkerSize()` Retrieves the marker size
`int`	`getMarkerType()` Retrieves the marker type.
`double`	`getRotation()` Retrieves the angle used to rotate the character.
`Paint`	`getStrokePaint()` Retrieves the paint used to draw the outline the character.
`boolean`	`isAntialiasing()` Retrieves the antialiasing value.
`void`	`setAntialiasing(boolean antialiasing)` Specifies is the `IlvFontMarker` should render the character antialiased.
`void`	`setChar(char c)` Sets the character used to render a point when an `IlvFontMarker` is used.
`void`	`setFillPaint(Paint paint)` Sets the fill paint used to fill the character.
`void`	`setFont(Font font)` Sets the font used to render a point when an `IlvFontMarker` is used.
`void`	`setMarkerColor(Color color)` Sets the marker color.
`void`	`setMarkerSize(int size)` Sets the size of the marker This attribute is only used when the associated renderer produces an `IlvMarker`.
`void`	`setMarkerType(int type)` Sets the marker type used to render the points.
`void`	`setRotation(double angle)` Sets the angle (in degrees) for the rotation of the character.
`void`	`setStrokePaint(Paint paint)` Sets the stroke paint used to draw the outline the character.
`void`	`write(IlvOutputStream stream)` Writes this style in an `IlvOutputStream`

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

- Constructor Detail
  - IlvMapPointRenderingStyle
```
public IlvMapPointRenderingStyle()
```
    Constructs a new IlvMapPointRenderingStyle with the defaults parameters values. Default values are:
    - marker type = IlvMarkerCircle
    - marker size = 4
    - marker color = black
    - character = Character.MIN_VALUE
    - font = null
    - antialiased = false
    - fill paint = black
    - stroke paint = null
    - angle = 0
  - IlvMapPointRenderingStyle
```
public IlvMapPointRenderingStyle(IlvInputStream stream)
                          throws IlvReadFileException
```
    Reads a IlvMapPointRenderingStyle from an IlvInputStream.
    
    Parameters:
    
    stream - The IlvInputStream.
    
    Throws:
    
    IlvReadFileException
- Method Detail
  - write
```
public void write(IlvOutputStream stream)
           throws IOException
```
    Writes this style in an IlvOutputStream
    
    Parameters:
    
    stream - The IlvOutputStream.
    
    Throws:
    
    IOException - thrown when an exception occurs during the write operation for this object.
  - setMarkerType
```
public void setMarkerType(int type)
```
    Sets the marker type used to render the points. This attribute is only used when the associated renderer produces an IlvMarker
    Parameters:
    type - The marker type. Recognized values are those recognized by an IlvMarker:
    
    IlvMarker.IlvMarkerSquare
    
    IlvMarker.IlvMarkerDiamond
    
    IlvMarker.IlvMarkerCircle
    
    IlvMarker.IlvMarkerCross
    
    IlvMarker.IlvMarkerPlus
    
    IlvMarker.IlvMarkerFilledSquare
    
    IlvMarker.IlvMarkerFilledCircle
    
    IlvMarker.IlvMarkerFilledDiamond
    
    IlvMarker.IlvMarkerTriangle
    
    IlvMarker.IlvMarkerFilledTriangle
    
    Bitwise OR combinations are supported to create more complex styles.
  - getMarkerType
```
public int getMarkerType()
```
    Retrieves the marker type.
    
    Returns:
    
    The current marker type.
  - setMarkerSize
```
public void setMarkerSize(int size)
```
    Sets the size of the marker This attribute is only used when the associated renderer produces an IlvMarker.
    
    Parameters:
    
    size - The marker size.
  - getMarkerSize
```
public int getMarkerSize()
```
    Retrieves the marker size
    
    Returns:
    
    The marker size.
  - setMarkerColor
```
public void setMarkerColor(Color color)
```
    Sets the marker color. This attribute is only used when the associated renderer produces an IlvMarker.
    
    Parameters:
    
    color - The marker color.
  - getMarkerColor
```
public Color getMarkerColor()
```
    Retrieves the marker color.
    
    Returns:
    
    The marker color.
  - setChar
```
public void setChar(char c)
```
    Sets the character used to render a point when an IlvFontMarker is used. The marker will then display the character c of the font specified by the setFont method.
    
    Parameters:
    
    c - The character to be displayed.
  - getChar
```
public char getChar()
```
    Retrieves the character used to render a point.
    
    Returns:
    
    The character.
  - setFont
```
public void setFont(Font font)
```
    Sets the font used to render a point when an IlvFontMarker is used. The marker will then display the character specified by the setChar method of the font specified by this method.
    
    Parameters:
    
    font - The font.
  - getFont
```
public Font getFont()
```
    Retrieves the font used to render a point.
    
    Returns:
    
    The font.
  - setAntialiasing
```
public void setAntialiasing(boolean antialiasing)
```
    Specifies is the IlvFontMarker should render the character antialiased. This attribute is only used when the associated renderer produces an IlvFontMarker.
    
    Parameters:
    
    antialiasing - true if the character will be rendered antialiased, false otherwise.
  - isAntialiasing
```
public boolean isAntialiasing()
```
    Retrieves the antialiasing value.
    
    Returns:
    
    true if the character is rendered antialiased, false otherwise.
  - setFillPaint
```
public void setFillPaint(Paint paint)
```
    Sets the fill paint used to fill the character. This attribute is only used when the associated renderer produces an IlvFontMarker.
    
    Parameters:
    
    paint - The Paint used to fill the character. If this parameter is set to null, the character will not be filled.
  - getFillPaint
```
public Paint getFillPaint()
```
    Retrieves the fill paint used to fill the character.
    
    Returns:
    
    The fill paint.
  - setStrokePaint
```
public void setStrokePaint(Paint paint)
```
    Sets the stroke paint used to draw the outline the character. This attribute is only used when the associated renderer produces an IlvFontMarker.
    
    Parameters:
    
    paint - the Paint used to draw the outline of the character. If this parameter is set to null, the outline of the character will not be drawn.
  - getStrokePaint
```
public Paint getStrokePaint()
```
    Retrieves the paint used to draw the outline the character.
    
    Returns:
    
    The paint used to draw the outline the character.
  - setRotation
```
public void setRotation(double angle)
```
    Sets the angle (in degrees) for the rotation of the character. This attribute is only used when the associated renderer produces an IlvFontMarker.
    
    Parameters:
    
    angle - The angle in degrees.
  - getRotation
```
public double getRotation()
```
    Retrieves the angle used to rotate the character.
    
    Returns:
    
    The angle used to rotate the character.

Class IlvMapPointRenderingStyle

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IlvMapPointRenderingStyle

IlvMapPointRenderingStyle

Method Detail

write

setMarkerType

getMarkerType

setMarkerSize

getMarkerSize

setMarkerColor

getMarkerColor

setChar

getChar

setFont

getFont

setAntialiasing

isAntialiasing

setFillPaint

getFillPaint

setStrokePaint

getStrokePaint

setRotation

getRotation