de.micromata.opengis.kml.v_2_2_0
Class LineStyle

java.lang.Object
  extended by de.micromata.opengis.kml.v_2_2_0.AbstractObject
      extended by de.micromata.opengis.kml.v_2_2_0.SubStyle
          extended by de.micromata.opengis.kml.v_2_2_0.ColorStyle
              extended by de.micromata.opengis.kml.v_2_2_0.LineStyle
All Implemented Interfaces:
java.lang.Cloneable

public class LineStyle
extends ColorStyle
implements java.lang.Cloneable

Specifies the drawing style (color, color mode, and line width) for all line geometry. Line geometry includes the outlines of outlined polygons and the extruded "tether" of Placemark icons (if extrusion is enabled).

Syntax:
<LineStyle id="ID">
   <!-- inherited from ColorStyle -->
   <color>ffffffff</color>            <!-- kml:color -->
   <colorMode>normal</colorMode>      <!-- colorModeEnum: normal or random -->
 
   <!-- specific to LineStyle -->
   <width>1</width>                   <!-- float -->
 </LineStyle>
Extends:


Field Summary
protected  java.util.List<AbstractObject> lineStyleObjectExtension
          
protected  java.util.List<java.lang.Object> lineStyleSimpleExtension
           
protected  double width
          
 
Fields inherited from class de.micromata.opengis.kml.v_2_2_0.ColorStyle
color, colorMode, colorStyleObjectExtension, colorStyleSimpleExtension
 
Fields inherited from class de.micromata.opengis.kml.v_2_2_0.SubStyle
subStyleObjectExtension, subStyleSimpleExtension
 
Fields inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject
id, objectSimpleExtension, targetId
 
Constructor Summary
LineStyle()
           
 
Method Summary
 LineStyle addToColorStyleObjectExtension(AbstractObject colorStyleObjectExtension)
          add a value to the colorStyleObjectExtension property collection
 LineStyle addToColorStyleSimpleExtension(java.lang.Object colorStyleSimpleExtension)
          add a value to the colorStyleSimpleExtension property collection
 LineStyle addToLineStyleObjectExtension(AbstractObject lineStyleObjectExtension)
          add a value to the lineStyleObjectExtension property collection
 LineStyle addToLineStyleSimpleExtension(java.lang.Object lineStyleSimpleExtension)
          add a value to the lineStyleSimpleExtension property collection
 LineStyle addToObjectSimpleExtension(java.lang.Object objectSimpleExtension)
          add a value to the objectSimpleExtension property collection
 LineStyle addToSubStyleObjectExtension(AbstractObject subStyleObjectExtension)
          add a value to the subStyleObjectExtension property collection
 LineStyle addToSubStyleSimpleExtension(java.lang.Object subStyleSimpleExtension)
          add a value to the subStyleSimpleExtension property collection
 LineStyle clone()
           
 boolean equals(java.lang.Object obj)
           
 java.util.List<AbstractObject> getLineStyleObjectExtension()
           
 java.util.List<java.lang.Object> getLineStyleSimpleExtension()
           
 double getWidth()
           
 int hashCode()
           
 void setColorStyleObjectExtension(java.util.List<AbstractObject> colorStyleObjectExtension)
           
 void setColorStyleSimpleExtension(java.util.List<java.lang.Object> colorStyleSimpleExtension)
           
 void setLineStyleObjectExtension(java.util.List<AbstractObject> lineStyleObjectExtension)
           
 void setLineStyleSimpleExtension(java.util.List<java.lang.Object> lineStyleSimpleExtension)
           
 void setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
           
 void setSubStyleObjectExtension(java.util.List<AbstractObject> subStyleObjectExtension)
          Sets the value of the subStyleObjectExtension property Objects of the following type(s) are allowed in the list List.
 void setSubStyleSimpleExtension(java.util.List<java.lang.Object> subStyleSimpleExtension)
          Sets the value of the subStyleSimpleExtension property Objects of the following type(s) are allowed in the list List.
 void setWidth(double value)
           
 LineStyle withColor(java.lang.String color)
          fluent setter
 LineStyle withColorMode(ColorMode colorMode)
          fluent setter
 LineStyle withColorStyleObjectExtension(java.util.List<AbstractObject> colorStyleObjectExtension)
          fluent setter
 LineStyle withColorStyleSimpleExtension(java.util.List<java.lang.Object> colorStyleSimpleExtension)
          fluent setter
 LineStyle withId(java.lang.String id)
          fluent setter
 LineStyle withLineStyleObjectExtension(java.util.List<AbstractObject> lineStyleObjectExtension)
          fluent setter
 LineStyle withLineStyleSimpleExtension(java.util.List<java.lang.Object> lineStyleSimpleExtension)
          fluent setter
 LineStyle withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
          fluent setter
 LineStyle withSubStyleObjectExtension(java.util.List<AbstractObject> subStyleObjectExtension)
          fluent setter
 LineStyle withSubStyleSimpleExtension(java.util.List<java.lang.Object> subStyleSimpleExtension)
          fluent setter
 LineStyle withTargetId(java.lang.String targetId)
          fluent setter
 LineStyle withWidth(double width)
          fluent setter
 
Methods inherited from class de.micromata.opengis.kml.v_2_2_0.ColorStyle
getColor, getColorMode, getColorStyleObjectExtension, getColorStyleSimpleExtension, setColor, setColorMode
 
Methods inherited from class de.micromata.opengis.kml.v_2_2_0.SubStyle
getSubStyleObjectExtension, getSubStyleSimpleExtension
 
Methods inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject
getId, getObjectSimpleExtension, getTargetId, setId, setTargetId
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

width

protected double width

Width of the line, in pixels.


lineStyleSimpleExtension

protected java.util.List<java.lang.Object> lineStyleSimpleExtension

lineStyleObjectExtension

protected java.util.List<AbstractObject> lineStyleObjectExtension

This is an abstract base class and cannot be used directly in a KML file. It provides the id attribute, which allows unique identification of a KML element, and the targetId attribute, which is used to reference objects that have already been loaded into Google Earth. The id attribute must be assigned if the mechanism is to be used.

Syntax:
<!-- abstract element; do not create -->
 <!-- Object id="ID" targetId="NCName" -->
 <!-- /Object> -->

Constructor Detail

LineStyle

public LineStyle()
Method Detail

getWidth

public double getWidth()
Returns:
possible object is Double
See Also:
width

setWidth

public void setWidth(double value)
Parameters:
value - allowed object is Double
See Also:
width

getLineStyleSimpleExtension

public java.util.List<java.lang.Object> getLineStyleSimpleExtension()
See Also:
lineStyleSimpleExtension

getLineStyleObjectExtension

public java.util.List<AbstractObject> getLineStyleObjectExtension()
See Also:
lineStyleObjectExtension

hashCode

public int hashCode()
Overrides:
hashCode in class ColorStyle

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class ColorStyle

setLineStyleSimpleExtension

public void setLineStyleSimpleExtension(java.util.List<java.lang.Object> lineStyleSimpleExtension)
Parameters:
lineStyleSimpleExtension -
See Also:
lineStyleSimpleExtension

addToLineStyleSimpleExtension

public LineStyle addToLineStyleSimpleExtension(java.lang.Object lineStyleSimpleExtension)
add a value to the lineStyleSimpleExtension property collection

Parameters:
lineStyleSimpleExtension - Objects of the following type are allowed in the list: Object
Returns:
true (as general contract of Collection.add).

setLineStyleObjectExtension

public void setLineStyleObjectExtension(java.util.List<AbstractObject> lineStyleObjectExtension)
Parameters:
lineStyleObjectExtension -
See Also:
lineStyleObjectExtension

addToLineStyleObjectExtension

public LineStyle addToLineStyleObjectExtension(AbstractObject lineStyleObjectExtension)
add a value to the lineStyleObjectExtension property collection

Parameters:
lineStyleObjectExtension - Objects of the following type are allowed in the list: AbstractObject
Returns:
true (as general contract of Collection.add).

setObjectSimpleExtension

public void setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
Overrides:
setObjectSimpleExtension in class ColorStyle
See Also:
objectSimpleExtension

addToObjectSimpleExtension

public LineStyle addToObjectSimpleExtension(java.lang.Object objectSimpleExtension)
Description copied from class: AbstractObject
add a value to the objectSimpleExtension property collection

Overrides:
addToObjectSimpleExtension in class ColorStyle
Parameters:
objectSimpleExtension - Objects of the following type are allowed in the list: Object
Returns:
true (as general contract of Collection.add).

setSubStyleSimpleExtension

public void setSubStyleSimpleExtension(java.util.List<java.lang.Object> subStyleSimpleExtension)
Description copied from class: SubStyle
Sets the value of the subStyleSimpleExtension property Objects of the following type(s) are allowed in the list List.

Note:

This method does not make use of the fluent pattern.If you would like to make it fluent, use SubStyle.withSubStyleSimpleExtension(java.util.List) instead.

Overrides:
setSubStyleSimpleExtension in class ColorStyle
See Also:
subStyleSimpleExtension

addToSubStyleSimpleExtension

public LineStyle addToSubStyleSimpleExtension(java.lang.Object subStyleSimpleExtension)
Description copied from class: SubStyle
add a value to the subStyleSimpleExtension property collection

Overrides:
addToSubStyleSimpleExtension in class ColorStyle
Parameters:
subStyleSimpleExtension - Objects of the following type are allowed in the list: Object
Returns:
true (as general contract of Collection.add).

setSubStyleObjectExtension

public void setSubStyleObjectExtension(java.util.List<AbstractObject> subStyleObjectExtension)
Description copied from class: SubStyle
Sets the value of the subStyleObjectExtension property Objects of the following type(s) are allowed in the list List.

Note:

This method does not make use of the fluent pattern.If you would like to make it fluent, use SubStyle.withSubStyleObjectExtension(java.util.List) instead.

Overrides:
setSubStyleObjectExtension in class ColorStyle
See Also:
subStyleObjectExtension

addToSubStyleObjectExtension

public LineStyle addToSubStyleObjectExtension(AbstractObject subStyleObjectExtension)
Description copied from class: SubStyle
add a value to the subStyleObjectExtension property collection

Overrides:
addToSubStyleObjectExtension in class ColorStyle
Parameters:
subStyleObjectExtension - Objects of the following type are allowed in the list: AbstractObject
Returns:
true (as general contract of Collection.add).

setColorStyleSimpleExtension

public void setColorStyleSimpleExtension(java.util.List<java.lang.Object> colorStyleSimpleExtension)
Overrides:
setColorStyleSimpleExtension in class ColorStyle
See Also:
colorStyleSimpleExtension

addToColorStyleSimpleExtension

public LineStyle addToColorStyleSimpleExtension(java.lang.Object colorStyleSimpleExtension)
Description copied from class: ColorStyle
add a value to the colorStyleSimpleExtension property collection

Overrides:
addToColorStyleSimpleExtension in class ColorStyle
Parameters:
colorStyleSimpleExtension - Objects of the following type are allowed in the list: Object
Returns:
true (as general contract of Collection.add).

setColorStyleObjectExtension

public void setColorStyleObjectExtension(java.util.List<AbstractObject> colorStyleObjectExtension)
Overrides:
setColorStyleObjectExtension in class ColorStyle
See Also:
colorStyleObjectExtension

addToColorStyleObjectExtension

public LineStyle addToColorStyleObjectExtension(AbstractObject colorStyleObjectExtension)
Description copied from class: ColorStyle
add a value to the colorStyleObjectExtension property collection

Overrides:
addToColorStyleObjectExtension in class ColorStyle
Parameters:
colorStyleObjectExtension - Objects of the following type are allowed in the list: AbstractObject
Returns:
true (as general contract of Collection.add).

withWidth

public LineStyle withWidth(double width)
fluent setter

Parameters:
width - required parameter
See Also:
setWidth(double)

withLineStyleSimpleExtension

public LineStyle withLineStyleSimpleExtension(java.util.List<java.lang.Object> lineStyleSimpleExtension)
fluent setter

Parameters:
lineStyleSimpleExtension - required parameter
See Also:
#setLineStyleSimpleExtension(List)

withLineStyleObjectExtension

public LineStyle withLineStyleObjectExtension(java.util.List<AbstractObject> lineStyleObjectExtension)
fluent setter

Parameters:
lineStyleObjectExtension - required parameter
See Also:
#setLineStyleObjectExtension(List)

withObjectSimpleExtension

public LineStyle withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
Description copied from class: AbstractObject
fluent setter

Overrides:
withObjectSimpleExtension in class ColorStyle
Parameters:
objectSimpleExtension - required parameter
See Also:
#setObjectSimpleExtension(List)

withId

public LineStyle withId(java.lang.String id)
Description copied from class: AbstractObject
fluent setter

Overrides:
withId in class ColorStyle
Parameters:
id - required parameter
See Also:
AbstractObject.setId(String)

withTargetId

public LineStyle withTargetId(java.lang.String targetId)
Description copied from class: AbstractObject
fluent setter

Overrides:
withTargetId in class ColorStyle
Parameters:
targetId - required parameter
See Also:
AbstractObject.setTargetId(String)

withSubStyleSimpleExtension

public LineStyle withSubStyleSimpleExtension(java.util.List<java.lang.Object> subStyleSimpleExtension)
Description copied from class: SubStyle
fluent setter

Overrides:
withSubStyleSimpleExtension in class ColorStyle
Parameters:
subStyleSimpleExtension - required parameter
See Also:
#setSubStyleSimpleExtension(List)

withSubStyleObjectExtension

public LineStyle withSubStyleObjectExtension(java.util.List<AbstractObject> subStyleObjectExtension)
Description copied from class: SubStyle
fluent setter

Overrides:
withSubStyleObjectExtension in class ColorStyle
Parameters:
subStyleObjectExtension - required parameter
See Also:
#setSubStyleObjectExtension(List)

withColor

public LineStyle withColor(java.lang.String color)
Description copied from class: ColorStyle
fluent setter

Overrides:
withColor in class ColorStyle
Parameters:
color - required parameter
See Also:
ColorStyle.setColor(String)

withColorMode

public LineStyle withColorMode(ColorMode colorMode)
Description copied from class: ColorStyle
fluent setter

Overrides:
withColorMode in class ColorStyle
Parameters:
colorMode - required parameter
See Also:
ColorStyle.setColorMode(ColorMode)

withColorStyleSimpleExtension

public LineStyle withColorStyleSimpleExtension(java.util.List<java.lang.Object> colorStyleSimpleExtension)
Description copied from class: ColorStyle
fluent setter

Overrides:
withColorStyleSimpleExtension in class ColorStyle
Parameters:
colorStyleSimpleExtension - required parameter
See Also:
#setColorStyleSimpleExtension(List)

withColorStyleObjectExtension

public LineStyle withColorStyleObjectExtension(java.util.List<AbstractObject> colorStyleObjectExtension)
Description copied from class: ColorStyle
fluent setter

Overrides:
withColorStyleObjectExtension in class ColorStyle
Parameters:
colorStyleObjectExtension - required parameter
See Also:
#setColorStyleObjectExtension(List)

clone

public LineStyle clone()
Overrides:
clone in class ColorStyle