Style (JMap 7.0 Kathmandu API Documentation)

java.lang.Object
- com.kheops.jmap.client.layers.Style

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

AbstractAnimation, StyleReference
```
public class Style
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable
```
A Style object contains all the information necessary to render the elements in a view. It defines their appearance (colors, line widths, fonts, etc). There is only one type of Style objects for all types of elements so not all members are used a given type of element.
Each Layer object has a default Style object that is used to draw its elements.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ARROW_BACKWARD` Constant defining an backward arrow
`static int`	`ARROW_FORWARD` Constant defining a forward arrow
`static int`	`ARROW_NONE` Constant defining the arrow style to none
`protected float`	`arrowPosition`
`protected int`	`arrowType`
`protected int`	`borderColor`
`protected KStroke`	`borderStroker`
`protected int`	`borderThickness`
`protected float`	`borderTransparency`
`protected boolean`	`drawHandles`
`protected byte[]`	`encodedSymbolData` Contains the raster symbol encoded image source.
`protected int`	`fillColor`
`protected java.lang.String`	`fontName`
`protected int`	`fontSize`
`protected int`	`fontStyle`
`protected int`	`lineColor`
`protected int`	`lineThickness`
`protected static int`	`OBJECT_VERSION_ID_6_5`
`protected int`	`objectVersionId`
`protected int`	`outlineColor`
`protected boolean`	`outlined`
`protected KPaint`	`painter`
`protected boolean`	`painterInvalidated`
`protected int`	`patternColor`
`protected int[]`	`patternData`
`protected KPaint`	`plainPainter`
`protected int`	`proportionalSymbolRefScale`
`protected KRenderingHints`	`renderingHints`
`protected KStroke`	`stroker`
`protected Symbol`	`symbol`
`protected float`	`symbolAngle`
`protected boolean`	`symbolAngleLocked`
`protected int[]`	`symbolData` Deprecated. use `encodedSymbolData` instead.
`protected int`	`symbolOffsetX`
`protected int`	`symbolOffsetY`
`protected float`	`symbolScale`
`protected int`	`textColor`
`protected float`	`transparency`
`protected boolean`	`transparentFill`
`protected boolean`	`transparentPatternFill`
`protected boolean`	`useProportionalSymbol`

Constructor Summary

Constructors
Constructor and Description

Style()
Constructs a new Style object with all members initialized to their default values.

Constructors
Constructor and Description
`Style()` Constructs a new Style object with all members initialized to their default values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()` Constructs a new Style object cloned on this style.
`protected void`	`clone(Style style)`
`void`	`createSelectedRasterSymbol(java.awt.Color selectionColor)` If the current symbol is a RasterSymbol instance, applies a RGB filter to that symbol using the specified selection color.
`void`	`drawSample(GraphicsRef gr, Rectangle rect, int type)` Draws a sample of the specified type of element using this style.
`void`	`drawSample(GraphicsRef gr, Rectangle rect, int type, boolean drawSymbolOffset)` Draws a sample of the specified type of element using this style.
`void`	`drawSample(GraphicsRef gr, Rectangle rect, int type, boolean drawSymbolOffset, boolean fitSymbolToRect)` Draws a sample of the specified type of element using this style.
`boolean`	`equals(java.lang.Object o)`
`float`	`getArrowPosition()` Gets the arrow position
`int`	`getArrowType()` Gets the arrow type
`java.awt.Color`	`getBorderColor()` Gets the color that is currently used to draw borders for different types of elements on the layer.
`KStroke`	`getBorderStroker()` Returns the stroker to use when drawing geometry borders.
`int`	`getBorderThickness()` Gets the thickness that is currently used to draw borders for different types of elements on the layer.
`float`	`getBorderTransparency()` Returns the transparency factor [0f - 1f] of the border, 1f means full transparency.
`java.awt.Color`	`getFillColor()` Gets the color that will be used to fill the interior of different types of elements on the layer.
`java.awt.Font`	`getFont()` Returns the current font used for drawing character symbols.
`java.awt.Color`	`getLineColor()` Gets the color that is currently used to draw lines (or borders) for different types of elements on the layer.
`int`	`getLineThickness()` Gets the thickness that is currently used to draw lines for different types of elements on the layer.
`java.awt.Color`	`getOutlineColor()` Returns the outline color used to draw text.
`KPaint`	`getPainter()` Returns the painter to use when filling geometries, if any.
`java.awt.Color`	`getPatternColor()` Returns the pattern color.
`KPaint`	`getPlainPainter()` Returns a painter instance that was not filled with the pattern nor the fill color.
`KRenderingHints`	`getRenderingHints()` Return rendering hints to use.
`KStroke`	`getStroker()` Returns the stroker to use when drawing linear geometries.
`Symbol`	`getSymbol()` Returns the current symbol.
`float`	`getSymbolAngle()` Returns the symbol angle.
`float`	`getSymbolScale()` Returns the symbol scale factor to use to draw K2DPoint elements on a view.
`java.awt.Color`	`getTextColor()` Gets the color that is currently used to draw text on the layer.
`float`	`getTransparency()` Returns the transparency factor [0f - 1f], 1f means full transparency.
`boolean`	`getTransparentFill()` Gets the state of the transparency flag.
`boolean`	`getTransparentPatternFill()` Returns the state of the pattern transparency flag.
`boolean`	`isDrawHandles()` Returns whether or not to draw handles.
`boolean`	`isOutlined()` Returns whether or not text should be drawn with an outline.
`boolean`	`isSymbolAngleLocked()` Returns true if the symbol angle is locked with the rotation of the view.
`void`	`setArrowPosition(float position)` Sets the arrow position
`void`	`setArrowType(int type)` Sets the arrow type
`void`	`setBorderColor(java.awt.Color color)` Sets the color that will be used to draw borders for different types of elements on the layer.
`void`	`setBorderStroker(KStroke borderStroker)` Sets the stroker to use when drawing geometry borders.
`void`	`setBorderThickness(int borderThickness)` Sets the thickness that will be used to draw borders for different types of elements on the layer.
`void`	`setBorderTransparency(float factor)` Sets the border transparency factor.
`void`	`setDrawHandles(boolean drawHandles)` Sets whether or not to draw handles.
`void`	`setFillColor(java.awt.Color color)` Sets the color that will be used to fill the interior of different types of elements on the layer.
`void`	`setFont(java.awt.Font font)` Changes the current font used for drawing character symbols.
`void`	`setLineColor(java.awt.Color color)` Sets the color that will be used to draw lines (or borders) for different types of elements on the layer.
`void`	`setLineThickness(int lineThickness)` Sets the thickness that will be used to draw lines (or borders) for different types of elements on the layer.
`void`	`setOutlineColor(java.awt.Color outlineColor)` Sets the outline color used to draw text.
`void`	`setOutlined(boolean outlined)` Sets whether or not text should be drawn with an outline.
`void`	`setPainter(KPaint painter)` Sets the painter to use.
`void`	`setPatternColor(java.awt.Color patternColor)` Sets the pattern color.
`void`	`setRenderingHints(KRenderingHints renderingHints)` Sets the rendering hints to use.
`void`	`setStroker(KStroke stroker)` Sets the stroker to use when drawing linear geometries.
`void`	`setStyleFromExisting(Style style)` Initializes this style parameters using the values of the specified style
`void`	`setSymbol(Symbol symbol)` Sets the current symbol.
`void`	`setSymbolAngle(float symbolAngle)` Sets the symbol angle.
`void`	`setSymbolAngleLocked(boolean symbolAngleLocked)` If `true`, the symbol angle will follow the view rotation.
`void`	`setSymbolScale(float scale)` Sets the symbol scale factor to use to draw the symbol on the view.
`void`	`setTextColor(java.awt.Color color)` Sets the color that will be used to draw text on the layer.
`void`	`setTransparency(float factor)` Sets the transparency factor.
`void`	`setTransparentFill(boolean flag)` Specifies how to draw the interior of certain types of elements (transparency flag).
`void`	`setTransparentPatternFill(boolean flag)` Specifies how to draw the interior of certain types of elements when you have a pattern (transparency flag).
`protected void`	`validateObjectImpl()`

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

- Field Detail
  - OBJECT_VERSION_ID_6_5
```
protected static final int OBJECT_VERSION_ID_6_5
```
    See Also:
    
    Constant Field Values
  - ARROW_NONE
```
public static final int ARROW_NONE
```
    Constant defining the arrow style to none
    
    See Also:
    
    Constant Field Values
  - ARROW_FORWARD
```
public static final int ARROW_FORWARD
```
    Constant defining a forward arrow
    
    See Also:
    
    Constant Field Values
  - ARROW_BACKWARD
```
public static final int ARROW_BACKWARD
```
    Constant defining an backward arrow
    
    See Also:
    
    Constant Field Values
  - objectVersionId
```
protected int objectVersionId
```
  - lineColor
```
protected int lineColor
```
  - borderColor
```
protected int borderColor
```
  - fillColor
```
protected int fillColor
```
  - textColor
```
protected int textColor
```
  - patternColor
```
protected int patternColor
```
  - outlineColor
```
protected int outlineColor
```
  - arrowType
```
protected int arrowType
```
  - arrowPosition
```
protected float arrowPosition
```
  - transparentFill
```
protected boolean transparentFill
```
  - transparentPatternFill
```
protected boolean transparentPatternFill
```
  - symbolScale
```
protected float symbolScale
```
  - symbolAngle
```
protected float symbolAngle
```
  - symbolAngleLocked
```
protected boolean symbolAngleLocked
```
  - patternData
```
protected int[] patternData
```
  - symbol
```
protected Symbol symbol
```
  - symbolData
```
@Deprecated
protected int[] symbolData
```
    Deprecated. use encodedSymbolData instead.
  - encodedSymbolData
```
protected byte[] encodedSymbolData
```
    Contains the raster symbol encoded image source.
    
    Since:
    
    7.0
  - useProportionalSymbol
```
protected boolean useProportionalSymbol
```
  - proportionalSymbolRefScale
```
protected int proportionalSymbolRefScale
```
  - fontName
```
protected java.lang.String fontName
```
  - fontStyle
```
protected int fontStyle
```
  - fontSize
```
protected int fontSize
```
  - outlined
```
protected boolean outlined
```
  - lineThickness
```
protected int lineThickness
```
  - borderThickness
```
protected int borderThickness
```
  - renderingHints
```
protected KRenderingHints renderingHints
```
  - stroker
```
protected KStroke stroker
```
  - borderStroker
```
protected KStroke borderStroker
```
  - painter
```
protected KPaint painter
```
  - painterInvalidated
```
protected transient boolean painterInvalidated
```
  - plainPainter
```
protected transient KPaint plainPainter
```
  - transparency
```
protected float transparency
```
  - borderTransparency
```
protected float borderTransparency
```
  - drawHandles
```
protected boolean drawHandles
```
  - symbolOffsetX
```
protected int symbolOffsetX
```
  - symbolOffsetY
```
protected int symbolOffsetY
```
- Constructor Detail
  - Style
```
public Style()
```
    Constructs a new Style object with all members initialized to their default values.
- Method Detail
  - getStroker
```
public KStroke getStroker()
```
    Returns the stroker to use when drawing linear geometries.
    
    Returns:
    
    the stroker to use.
    
    See Also:
    
    Stroke
  - getBorderStroker
```
public KStroke getBorderStroker()
```
    Returns the stroker to use when drawing geometry borders.
    
    Returns:
    
    the stroker to use.
    
    See Also:
    
    Stroke
  - setStroker
```
public void setStroker(KStroke stroker)
```
    Sets the stroker to use when drawing linear geometries.
    
    Parameters:
    
    stroker - the stroker to use.
    
    See Also:
    
    Stroke
  - setBorderStroker
```
public void setBorderStroker(KStroke borderStroker)
```
    Sets the stroker to use when drawing geometry borders.
    
    Parameters:
    
    borderStroker - the stroker to use.
    
    See Also:
    
    Stroke
  - getPainter
```
public KPaint getPainter()
```
    Returns the painter to use when filling geometries, if any.
    
    Returns:
    
    the painter to use.
    
    See Also:
    
    Paint
  - getPlainPainter
```
public KPaint getPlainPainter()
```
    Returns a painter instance that was not filled with the pattern nor the fill color.
    
    Returns:
    
    the plain painter instance.
  - setPainter
```
public void setPainter(KPaint painter)
```
    Sets the painter to use.
    
    Parameters:
    
    painter - the painter to use.
    
    See Also:
    
    Paint
  - getRenderingHints
```
public KRenderingHints getRenderingHints()
```
    Return rendering hints to use. May be used or not by the system.
    
    Returns:
    
    rendering hints to use.
    
    See Also:
    
    RenderingHints
  - setRenderingHints
```
public void setRenderingHints(KRenderingHints renderingHints)
```
    Sets the rendering hints to use. May be used or not by the system.
    
    Parameters:
    
    renderingHints - rendering hints to use.
    
    See Also:
    
    RenderingHints
  - setTransparentFill
```
public void setTransparentFill(boolean flag)
```
    Specifies how to draw the interior of certain types of elements (transparency flag).
    
    Parameters:
    
    flag - if true, the interior of the elements will be transparent, otherwise the interior will be drawn using the style current fillColor.
  - setTransparentPatternFill
```
public void setTransparentPatternFill(boolean flag)
```
    Specifies how to draw the interior of certain types of elements when you have a pattern (transparency flag).
    
    Parameters:
    
    flag - if true, the interior of the elements will be transparent, otherwise the interior will be drawn using the style current patternfillColor.
  - getTransparentFill
```
public boolean getTransparentFill()
```
    Gets the state of the transparency flag.
    
    Returns:
    
    the state of the transparency flag
    
    See Also:
    
    setTransparentFill(boolean)
  - getTransparentPatternFill
```
public boolean getTransparentPatternFill()
```
    Returns the state of the pattern transparency flag.
    
    Returns:
    
    the state of the pattern transparency flag
    
    See Also:
    
    setTransparentPatternFill(boolean)
  - getSymbolScale
```
public float getSymbolScale()
```
    Returns the symbol scale factor to use to draw K2DPoint elements on a view.
    
    Returns:
    
    the current scale factor of the symbol
  - setSymbolScale
```
public void setSymbolScale(float scale)
```
    Sets the symbol scale factor to use to draw the symbol on the view.
    
    Parameters:
    
    scale - the new scale factor
  - setBorderColor
```
public void setBorderColor(java.awt.Color color)
```
    Sets the color that will be used to draw borders for different types of elements on the layer.
    
    Parameters:
    
    color - the new color to use
  - setLineColor
```
public void setLineColor(java.awt.Color color)
```
    Sets the color that will be used to draw lines (or borders) for different types of elements on the layer.
    
    Parameters:
    
    color - the new color to use
  - getLineColor
```
public java.awt.Color getLineColor()
```
    Gets the color that is currently used to draw lines (or borders) for different types of elements on the layer.
    
    Returns:
    
    the currently used color
  - getBorderColor
```
public java.awt.Color getBorderColor()
```
    Gets the color that is currently used to draw borders for different types of elements on the layer.
    
    Returns:
    
    the currently used color
  - setTextColor
```
public void setTextColor(java.awt.Color color)
```
    Sets the color that will be used to draw text on the layer.
    
    Parameters:
    
    color - the new color to use
  - getTextColor
```
public java.awt.Color getTextColor()
```
    Gets the color that is currently used to draw text on the layer.
    
    Returns:
    
    the currently used color
  - setLineThickness
```
public void setLineThickness(int lineThickness)
```
    Sets the thickness that will be used to draw lines (or borders) for different types of elements on the layer.
    
    Parameters:
    
    lineThickness - the new thickness to use
  - setBorderThickness
```
public void setBorderThickness(int borderThickness)
```
    Sets the thickness that will be used to draw borders for different types of elements on the layer.
    
    Parameters:
    
    borderThickness - the new thickness to use
  - getLineThickness
```
public int getLineThickness()
```
    Gets the thickness that is currently used to draw lines for different types of elements on the layer.
    
    Returns:
    
    the currently used thickness
  - getBorderThickness
```
public int getBorderThickness()
```
    Gets the thickness that is currently used to draw borders for different types of elements on the layer.
    
    Returns:
    
    the currently used thickness
  - setFillColor
```
public void setFillColor(java.awt.Color color)
```
    Sets the color that will be used to fill the interior of different types of elements on the layer.
    
    Parameters:
    
    color - the new color to use
  - getFillColor
```
public java.awt.Color getFillColor()
```
    Gets the color that will be used to fill the interior of different types of elements on the layer.
    
    Returns:
    
    the currently used color
  - clone
```
protected void clone(Style style)
```
  - clone
```
public java.lang.Object clone()
```
    Constructs a new Style object cloned on this style.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    a new style object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - setStyleFromExisting
```
public void setStyleFromExisting(Style style)
```
    Initializes this style parameters using the values of the specified style
    
    Parameters:
    
    style -
  - createSelectedRasterSymbol
```
public void createSelectedRasterSymbol(java.awt.Color selectionColor)
```
    If the current symbol is a RasterSymbol instance, applies a RGB filter to that symbol using the specified selection color.
    
    Parameters:
    
    selectionColor - the color to apply on the raster symbol.
  - drawSample
```
public void drawSample(GraphicsRef gr,
                       Rectangle rect,
                       int type)
```
    Draws a sample of the specified type of element using this style.
    
    Parameters:
    
    gr - the GraphicsRef object used to draw with
    
    rect - the rectangle inside which the sample must be drawn
    
    type - the type of element
  - drawSample
```
public void drawSample(GraphicsRef gr,
                       Rectangle rect,
                       int type,
                       boolean drawSymbolOffset)
```
    Draws a sample of the specified type of element using this style.
    
    Parameters:
    
    gr - the GraphicsRef object used to draw with
    
    rect - the rectangle inside which the sample must be drawn
    
    type - the type of element
    
    drawSymbolOffset - Draw or not the symbol offset and the grid.
  - drawSample
```
public void drawSample(GraphicsRef gr,
                       Rectangle rect,
                       int type,
                       boolean drawSymbolOffset,
                       boolean fitSymbolToRect)
```
    Draws a sample of the specified type of element using this style.
    
    Parameters:
    
    gr - the GraphicsRef object used to draw with
    
    rect - the rectangle inside which the sample must be drawn
    
    type - the type of element
    
    drawSymbolOffset - Draw or not the symbol offset and the grid.
    
    fitSymbolToRect - (Point style only) If the symbol is bigger than rect, fit it to specified rect. Default is true.
  - getArrowType
```
public int getArrowType()
```
    Gets the arrow type
    
    Returns:
    
    arrowType
  - setArrowType
```
public void setArrowType(int type)
```
    Sets the arrow type
    
    Parameters:
    
    type - integer representing the arrow type
  - getArrowPosition
```
public float getArrowPosition()
```
    Gets the arrow position
    
    Returns:
    
    the arrow position
  - setArrowPosition
```
public void setArrowPosition(float position)
```
    Sets the arrow position
    
    Parameters:
    
    position - the position to set the arrow
  - getTransparency
```
public float getTransparency()
```
    Returns the transparency factor [0f - 1f], 1f means full transparency.
    
    Returns:
    
    the transparency factor.
  - setTransparency
```
public void setTransparency(float factor)
```
    Sets the transparency factor.
    
    Parameters:
    
    factor - the transparency factor to set. (value between 0f and 1f).
    
    See Also:
    
    getTransparency()
  - getBorderTransparency
```
public float getBorderTransparency()
```
    Returns the transparency factor [0f - 1f] of the border, 1f means full transparency.
    
    Returns:
    
    the transparency factor.
  - setBorderTransparency
```
public void setBorderTransparency(float factor)
```
    Sets the border transparency factor.
    
    Parameters:
    
    factor - the transparency factor to set. (value between 0f and 1f).
    
    See Also:
    
    getTransparency()
  - getFont
```
public java.awt.Font getFont()
```
    Returns the current font used for drawing character symbols.
    
    Returns:
    
    the currently used font object
  - setFont
```
public void setFont(java.awt.Font font)
```
    Changes the current font used for drawing character symbols.
    
    Parameters:
    
    font - the new font object to use
  - getOutlineColor
```
public java.awt.Color getOutlineColor()
```
    Returns the outline color used to draw text.
    
    Returns:
    
    the outline color.
  - setOutlineColor
```
public void setOutlineColor(java.awt.Color outlineColor)
```
    Sets the outline color used to draw text.
    
    Parameters:
    
    outlineColor - the outline color to set.
  - getPatternColor
```
public java.awt.Color getPatternColor()
```
    Returns the pattern color.
    
    Returns:
    
    the pattern color to set.
    
    See Also:
    
    getPainter()
  - setPatternColor
```
public void setPatternColor(java.awt.Color patternColor)
```
    Sets the pattern color.
    
    Parameters:
    
    patternColor - the pattern color to set.
  - getSymbol
```
public Symbol getSymbol()
```
    Returns the current symbol.
    
    Returns:
    
    the current symbol.
  - setSymbol
```
public void setSymbol(Symbol symbol)
```
    Sets the current symbol.
    
    Parameters:
    
    symbol - the new symbol.
  - isDrawHandles
```
public boolean isDrawHandles()
```
    Returns whether or not to draw handles.
    
    Returns:
    
    whether or not to draw handles.
  - setDrawHandles
```
public void setDrawHandles(boolean drawHandles)
```
    Sets whether or not to draw handles.
    
    Parameters:
    
    drawHandles - whether or not to draw handles.
  - getSymbolAngle
```
public float getSymbolAngle()
```
    Returns the symbol angle.
    
    Returns:
    
    the symbol angle.
  - setSymbolAngle
```
public void setSymbolAngle(float symbolAngle)
```
    Sets the symbol angle.
    
    Parameters:
    
    symbolAngle -
  - isSymbolAngleLocked
```
public boolean isSymbolAngleLocked()
```
    Returns true if the symbol angle is locked with the rotation of the view.
    
    Returns:
    
    true if locked with the view rotation.
  - setSymbolAngleLocked
```
public void setSymbolAngleLocked(boolean symbolAngleLocked)
```
    If true, the symbol angle will follow the view rotation.
    
    Parameters:
    
    symbolAngleLocked -
  - setOutlined
```
public void setOutlined(boolean outlined)
```
    Sets whether or not text should be drawn with an outline.
    
    Parameters:
    
    outlined - the flag state.
  - isOutlined
```
public boolean isOutlined()
```
    Returns whether or not text should be drawn with an outline.
    
    Returns:
    
    whether or not text should be drawn with an outline.
  - validateObjectImpl
```
protected void validateObjectImpl()
```

Class Style

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OBJECT_VERSION_ID_6_5

ARROW_NONE

ARROW_FORWARD

ARROW_BACKWARD

objectVersionId

lineColor

borderColor

fillColor

textColor

patternColor

outlineColor

arrowType

arrowPosition

transparentFill

transparentPatternFill

symbolScale

symbolAngle

symbolAngleLocked

patternData

symbol

symbolData

encodedSymbolData

useProportionalSymbol

proportionalSymbolRefScale

fontName

fontStyle

fontSize

outlined

lineThickness

borderThickness

renderingHints

stroker

borderStroker

painter

painterInvalidated

plainPainter

transparency

borderTransparency

drawHandles

symbolOffsetX

symbolOffsetY

Constructor Detail

Style

Method Detail

getStroker

getBorderStroker

setStroker

setBorderStroker

getPainter

getPlainPainter

setPainter

getRenderingHints

setRenderingHints

setTransparentFill

setTransparentPatternFill

getTransparentFill

getTransparentPatternFill

getSymbolScale

setSymbolScale

setBorderColor

setLineColor

getLineColor

getBorderColor

setTextColor

getTextColor

setLineThickness

setBorderThickness

getLineThickness

getBorderThickness

setFillColor

getFillColor

clone

clone

equals