BasicStyle (cismap Commons [9.2-SNAPSHOT] 9.2-SNAPSHOT API)

java.lang.Object
- de.cismet.cismap.commons.featureservice.style.BasicStyle

All Implemented Interfaces:

ConvertableToXML, Style, Cloneable, Comparable
```
public class BasicStyle
extends Object
implements Style
```
BasicStyle implements the Style-interface. It represents a collection of different variables (like colors, sizes, etc.) to configure the StyleDialog.

Version:

$Revision$, $Date$

Author:

haffkeatcismet

Field Summary

Fields
Modifier and Type	Field and Description
`protected float`	`alignment`
`protected float`	`alpha`
`protected String`	`attribute`
`protected boolean`	`autoscale`
`protected Color`	`colorFill`
`protected Color`	`colorLine`
`protected static Font`	`DEFAULT_FONT`
`protected boolean`	`drawFill`
`protected boolean`	`drawLabel`
`protected boolean`	`drawLine`
`protected Font`	`font`
`protected Color`	`fontColor`
`protected Color`	`halo`
`protected boolean`	`highlightFeature`
`protected int`	`lineWidth`
`protected org.apache.log4j.Logger`	`logger`
`protected int`	`maxScale`
`protected int`	`minScale`
`protected double`	`multiplier`
`protected FeatureAnnotationSymbol`	`pointSymbol`
`protected static String`	`POINTSYMBOL_FOLDER`
`protected String`	`pointSymbolFilename`
`protected int`	`pointSymbolSize`

Fields inherited from interface de.cismet.cismap.commons.featureservice.style.Style
ALIGNMENT, ALPHA, ATTRIBUTE, AUTO_POINTSYMBOL, AUTOSCALE, COLOR, FAMILY, FILL, HALO, HIGHLIGHT, LABEL, LINE, MAX_POINTSYMBOLSIZE, MAX_SCALE, MIN_POINTSYMBOLSIZE, MIN_SCALE, MULTIPLIER, NAME, NO_POINTSYMBOL, PAINT, POINTSYMBOL, SIZE, STYLE, STYLE_ELEMENT, WIDTH

Fields inherited from interface de.cismet.cismap.commons.ConvertableToXML
TYPE_ATTRIBUTE

Constructor Summary

Constructors
Constructor and Description
`BasicStyle()` Creates either an empty or default BasicStyle.
`BasicStyle(boolean drawFill, Color colorFill, boolean drawLine, Color colorLine, int lineWidth, boolean highlightFeature, float alpha, String pointSymbolName, int pointSymbolSize, boolean drawLabel, Font font, Color fontColor, String attribute, float alignment, int minScale, int maxScale, double multiplier, boolean autoscale, Color halo)` Creates a new BasicStyle.
`BasicStyle(org.jdom.Element element)` Creates a new BasicStyle object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Object`	`clone()` Creates an exact copy of this BasicStyle.
`int`	`compareTo(Object o)` Compares this BasicStyle with the delivered object.
`FeatureAnnotationSymbol`	`createAutoPointSymbol()` DOCUMENT ME!
`static Color`	`darken(Color c)` Darkens the delivered color to 60%.
`float`	`getAlignment()` DOCUMENT ME!
`float`	`getAlpha()` DOCUMENT ME!
`Color`	`getFillColor()` DOCUMENT ME!
`Font`	`getFont()` DOCUMENT ME!
`Color`	`getFontColor()` DOCUMENT ME!
`Color`	`getHalo()` DOCUMENT ME!
`String`	`getLabel()` Deprecated.
`Color`	`getLineColor()` DOCUMENT ME!
`int`	`getLineWidth()` DOCUMENT ME!
`int`	`getMaxScale()` DOCUMENT ME!
`int`	`getMinScale()` DOCUMENT ME!
`double`	`getMultiplier()` DOCUMENT ME!
`FeatureAnnotationSymbol`	`getPointSymbol()` DOCUMENT ME!
`String`	`getPointSymbolFilename()` DOCUMENT ME!
`int`	`getPointSymbolSize()` DOCUMENT ME!
`void`	`initFromElement(org.jdom.Element element)` Initialies an object that implements the ConvertableToXML interface from a DOM Element.
`boolean`	`isAutoscale()` DOCUMENT ME!
`boolean`	`isDrawFill()` DOCUMENT ME!
`boolean`	`isDrawLabel()` DOCUMENT ME!
`boolean`	`isDrawLine()` DOCUMENT ME!
`boolean`	`isHighlightFeature()` DOCUMENT ME!
`static Color`	`lighten(Color c)` Brightens the delivered color for aprox.
`void`	`setAlignment(float alignment)` DOCUMENT ME!
`void`	`setAlpha(float alpha)` DOCUMENT ME!
`void`	`setAutoscale(boolean autoscale)` DOCUMENT ME!
`void`	`setDefaultValues()` Resets this BasicStyle back to default.
`void`	`setDrawFill(boolean drawFill)` DOCUMENT ME!
`void`	`setDrawLabel(boolean drawLabel)` DOCUMENT ME!
`void`	`setDrawLine(boolean drawLine)` DOCUMENT ME!
`void`	`setFillColor(Color colorFill)` DOCUMENT ME!
`void`	`setFont(Font font)` DOCUMENT ME!
`void`	`setFontColor(Color fontColor)` DOCUMENT ME!
`void`	`setHalo(Color halo)` DOCUMENT ME!
`void`	`setHighlightFeature(boolean highlightFeature)` DOCUMENT ME!
`void`	`setLabel(String attribute)` Deprecated.
`void`	`setLineColor(Color colorLine)` DOCUMENT ME!
`void`	`setLineWidth(int lineWidth)` DOCUMENT ME!
`void`	`setMaxScale(int maxScale)` DOCUMENT ME!
`void`	`setMinScale(int minScale)` DOCUMENT ME!
`void`	`setMultiplier(double multiplier)` DOCUMENT ME!
`void`	`setPointSymbol(FeatureAnnotationSymbol pointSymbol)` Deprecated.
`void`	`setPointSymbolFilename(String pointSymbolFilename)` DOCUMENT ME!
`void`	`setPointSymbolSize(int pointSymbolSize)` DOCUMENT ME!
`org.jdom.Element`	`toElement()` Creates a JDOM-element that represents this BasicStyle.

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

- Field Detail
  - DEFAULT_FONT
```
protected static final Font DEFAULT_FONT
```
  - POINTSYMBOL_FOLDER
```
protected static final String POINTSYMBOL_FOLDER
```
    See Also:
    
    Constant Field Values
  - logger
```
protected final org.apache.log4j.Logger logger
```
  - drawFill
```
protected boolean drawFill
```
  - drawLine
```
protected boolean drawLine
```
  - colorFill
```
protected Color colorFill
```
  - colorLine
```
protected Color colorLine
```
  - lineWidth
```
protected int lineWidth
```
  - highlightFeature
```
protected boolean highlightFeature
```
  - alpha
```
protected float alpha
```
  - pointSymbolFilename
```
protected String pointSymbolFilename
```
  - pointSymbolSize
```
protected int pointSymbolSize
```
  - drawLabel
```
protected boolean drawLabel
```
  - font
```
protected Font font
```
  - fontColor
```
protected Color fontColor
```
  - attribute
```
protected String attribute
```
  - alignment
```
protected float alignment
```
  - minScale
```
protected int minScale
```
  - maxScale
```
protected int maxScale
```
  - multiplier
```
protected double multiplier
```
  - autoscale
```
protected boolean autoscale
```
  - pointSymbol
```
protected FeatureAnnotationSymbol pointSymbol
```
  - halo
```
protected Color halo
```
- Constructor Detail
  - BasicStyle
```
public BasicStyle()
```
    Creates either an empty or default BasicStyle.
  - BasicStyle
```
public BasicStyle(org.jdom.Element element)
           throws Exception
```
    Creates a new BasicStyle object.
    
    Parameters:
    
    element - DOCUMENT ME!
    
    Throws:
    
    Exception - DOCUMENT ME!
  - BasicStyle
```
public BasicStyle(boolean drawFill,
                  Color colorFill,
                  boolean drawLine,
                  Color colorLine,
                  int lineWidth,
                  boolean highlightFeature,
                  float alpha,
                  String pointSymbolName,
                  int pointSymbolSize,
                  boolean drawLabel,
                  Font font,
                  Color fontColor,
                  String attribute,
                  float alignment,
                  int minScale,
                  int maxScale,
                  double multiplier,
                  boolean autoscale,
                  Color halo)
```
    Creates a new BasicStyle.
    
    Parameters:
    
    drawFill - true if the filling should be painted, else false
    
    colorFill - the fillingcolor
    
    drawLine - true if the line should be painted, else false
    
    colorLine - the linecolor
    
    lineWidth - the linewidth
    
    highlightFeature - true if features should lighten up on mouseover
    
    alpha - alpha-value (0=invisible to 1=visible)
    
    pointSymbolName - name of the pointsymbol
    
    pointSymbolSize - size of the pointsymobl
    
    drawLabel - true if the labels should be painted, else false
    
    font - fonttype of the labels
    
    fontColor - the fontcolor
    
    attribute - attribute that be shown as label
    
    alignment - alignment of the label
    
    minScale - minimum scale at which the label is still visible
    
    maxScale - maximum scale at which the label is still visible
    
    multiplier - the size multiplier (non-effective if autoscale is enabled)
    
    autoscale - true to resize the label according to the zoomlevel, else false
    
    halo - DOCUMENT ME!
- Method Detail
  - setDefaultValues
```
public void setDefaultValues()
```
    Resets this BasicStyle back to default.
  - toElement
```
public org.jdom.Element toElement()
```
    Creates a JDOM-element that represents this BasicStyle.
    
    Specified by:
    
    toElement in interface ConvertableToXML
    
    Returns:
    
    JDOM-Element
  - compareTo
```
public int compareTo(Object o)
```
    Compares this BasicStyle with the delivered object.
    
    Specified by:
    
    compareTo in interface Comparable
    
    Parameters:
    
    o - object that should be compared with this BasicStyle
    
    Returns:
    
    0 if the objects are equal, else -1
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Creates an exact copy of this BasicStyle.
    
    Specified by:
    
    clone in interface Style
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    copy of this BasicStyle.
    
    Throws:
    
    CloneNotSupportedException - DOCUMENT ME!
  - isDrawFill
```
public boolean isDrawFill()
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    isDrawFill in interface Style
    
    Returns:
    
    DOCUMENT ME!
  - setDrawFill
```
public void setDrawFill(boolean drawFill)
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    setDrawFill in interface Style
    
    Parameters:
    
    drawFill - DOCUMENT ME!
  - isDrawLine
```
public boolean isDrawLine()
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    isDrawLine in interface Style
    
    Returns:
    
    DOCUMENT ME!
  - setDrawLine
```
public void setDrawLine(boolean drawLine)
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    setDrawLine in interface Style
    
    Parameters:
    
    drawLine - DOCUMENT ME!
  - isHighlightFeature
```
public boolean isHighlightFeature()
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    isHighlightFeature in interface Style
    
    Returns:
    
    DOCUMENT ME!
  - setHighlightFeature
```
public void setHighlightFeature(boolean highlightFeature)
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    setHighlightFeature in interface Style
    
    Parameters:
    
    highlightFeature - DOCUMENT ME!
  - getFillColor
```
public Color getFillColor()
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    getFillColor in interface Style
    
    Returns:
    
    DOCUMENT ME!
  - setFillColor
```
public void setFillColor(Color colorFill)
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    setFillColor in interface Style
    
    Parameters:
    
    colorFill - DOCUMENT ME!
  - getLineColor
```
public Color getLineColor()
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    getLineColor in interface Style
    
    Returns:
    
    DOCUMENT ME!
  - setLineColor
```
public void setLineColor(Color colorLine)
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    setLineColor in interface Style
    
    Parameters:
    
    colorLine - DOCUMENT ME!
  - getLineWidth
```
public int getLineWidth()
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    getLineWidth in interface Style
    
    Returns:
    
    DOCUMENT ME!
  - setLineWidth
```
public void setLineWidth(int lineWidth)
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    setLineWidth in interface Style
    
    Parameters:
    
    lineWidth - DOCUMENT ME!
  - getAlpha
```
public float getAlpha()
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    getAlpha in interface Style
    
    Returns:
    
    DOCUMENT ME!
  - setAlpha
```
public void setAlpha(float alpha)
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    setAlpha in interface Style
    
    Parameters:
    
    alpha - DOCUMENT ME!
  - getPointSymbolFilename
```
public String getPointSymbolFilename()
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    getPointSymbolFilename in interface Style
    
    Returns:
    
    DOCUMENT ME!
  - setPointSymbolFilename
```
public void setPointSymbolFilename(String pointSymbolFilename)
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    setPointSymbolFilename in interface Style
    
    Parameters:
    
    pointSymbolFilename - DOCUMENT ME!
  - getPointSymbolSize
```
public int getPointSymbolSize()
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    getPointSymbolSize in interface Style
    
    Returns:
    
    DOCUMENT ME!
  - setPointSymbolSize
```
public void setPointSymbolSize(int pointSymbolSize)
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    setPointSymbolSize in interface Style
    
    Parameters:
    
    pointSymbolSize - DOCUMENT ME!
  - isDrawLabel
```
public boolean isDrawLabel()
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    isDrawLabel in interface Style
    
    Returns:
    
    DOCUMENT ME!
  - setDrawLabel
```
public void setDrawLabel(boolean drawLabel)
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    setDrawLabel in interface Style
    
    Parameters:
    
    drawLabel - DOCUMENT ME!
  - getFont
```
public Font getFont()
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    getFont in interface Style
    
    Returns:
    
    DOCUMENT ME!
  - setFont
```
public void setFont(Font font)
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    setFont in interface Style
    
    Parameters:
    
    font - DOCUMENT ME!
  - getFontColor
```
public Color getFontColor()
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    getFontColor in interface Style
    
    Returns:
    
    DOCUMENT ME!
  - setFontColor
```
public void setFontColor(Color fontColor)
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    setFontColor in interface Style
    
    Parameters:
    
    fontColor - DOCUMENT ME!
  - setHalo
```
public void setHalo(Color halo)
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    setHalo in interface Style
    
    Parameters:
    
    halo - DOCUMENT ME!
  - getHalo
```
public Color getHalo()
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    getHalo in interface Style
    
    Returns:
    
    DOCUMENT ME!
  - getLabel
```
@Deprecated
public String getLabel()
```
    Deprecated.
    
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    getLabel in interface Style
    
    Returns:
    
    DOCUMENT ME!
  - setLabel
```
@Deprecated
public void setLabel(String attribute)
```
    Deprecated.
    
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    setLabel in interface Style
    
    Parameters:
    
    attribute - DOCUMENT ME!
  - getAlignment
```
public float getAlignment()
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    getAlignment in interface Style
    
    Returns:
    
    DOCUMENT ME!
  - setAlignment
```
public void setAlignment(float alignment)
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    setAlignment in interface Style
    
    Parameters:
    
    alignment - DOCUMENT ME!
  - getMinScale
```
public int getMinScale()
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    getMinScale in interface Style
    
    Returns:
    
    DOCUMENT ME!
  - setMinScale
```
public void setMinScale(int minScale)
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    setMinScale in interface Style
    
    Parameters:
    
    minScale - DOCUMENT ME!
  - getMaxScale
```
public int getMaxScale()
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    getMaxScale in interface Style
    
    Returns:
    
    DOCUMENT ME!
  - setMaxScale
```
public void setMaxScale(int maxScale)
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    setMaxScale in interface Style
    
    Parameters:
    
    maxScale - DOCUMENT ME!
  - getMultiplier
```
public double getMultiplier()
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    getMultiplier in interface Style
    
    Returns:
    
    DOCUMENT ME!
  - setMultiplier
```
public void setMultiplier(double multiplier)
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    setMultiplier in interface Style
    
    Parameters:
    
    multiplier - DOCUMENT ME!
  - isAutoscale
```
public boolean isAutoscale()
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    isAutoscale in interface Style
    
    Returns:
    
    DOCUMENT ME!
  - setAutoscale
```
public void setAutoscale(boolean autoscale)
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    setAutoscale in interface Style
    
    Parameters:
    
    autoscale - DOCUMENT ME!
  - initFromElement
```
public void initFromElement(org.jdom.Element element)
                     throws Exception
```
    Description copied from interface: ConvertableToXML
    
    Initialies an object that implements the ConvertableToXML interface from a DOM Element.
    
    Specified by:
    
    initFromElement in interface ConvertableToXML
    
    Parameters:
    
    element - the elemen to be reconstructed
    
    Throws:
    
    Exception - if the object could not be initialized
  - setPointSymbol
```
@Deprecated
public void setPointSymbol(FeatureAnnotationSymbol pointSymbol)
```
    Deprecated.
    
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    setPointSymbol in interface Style
    
    Parameters:
    
    pointSymbol - DOCUMENT ME!
  - getPointSymbol
```
public FeatureAnnotationSymbol getPointSymbol()
```
    Description copied from interface: Style
    
    DOCUMENT ME!
    
    Specified by:
    
    getPointSymbol in interface Style
    
    Returns:
    
    DOCUMENT ME!
  - darken
```
public static Color darken(Color c)
```
    Darkens the delivered color to 60%.
    
    Parameters:
    
    c - color that should be darker
    
    Returns:
    
    darkened color
  - lighten
```
public static Color lighten(Color c)
```
    Brightens the delivered color for aprox. 66%;.
    
    Parameters:
    
    c - color that should be lighter
    
    Returns:
    
    brightened color
  - createAutoPointSymbol
```
public FeatureAnnotationSymbol createAutoPointSymbol()
```
    DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!

Class BasicStyle

Field Summary

Fields inherited from interface de.cismet.cismap.commons.featureservice.style.Style

Fields inherited from interface de.cismet.cismap.commons.ConvertableToXML

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_FONT

POINTSYMBOL_FOLDER

logger

drawFill

drawLine

colorFill

colorLine

lineWidth

highlightFeature

alpha

pointSymbolFilename

pointSymbolSize

drawLabel

font

fontColor

attribute

alignment

minScale

maxScale

multiplier

autoscale

pointSymbol

halo

Constructor Detail

BasicStyle

BasicStyle

BasicStyle

Method Detail

setDefaultValues

toElement

compareTo

clone

isDrawFill

setDrawFill

isDrawLine

setDrawLine

isHighlightFeature

setHighlightFeature

getFillColor

setFillColor

getLineColor

setLineColor

getLineWidth

setLineWidth

getAlpha

setAlpha

getPointSymbolFilename

setPointSymbolFilename

getPointSymbolSize

setPointSymbolSize

isDrawLabel

setDrawLabel

getFont

setFont

getFontColor

setFontColor

setHalo

getHalo

getLabel

setLabel

getAlignment

setAlignment

getMinScale

setMinScale

getMaxScale

setMaxScale

getMultiplier

setMultiplier

isAutoscale

setAutoscale

initFromElement

setPointSymbol