de.micromata.opengis.kml.v_2_2_0
Class ColorStyle

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
All Implemented Interfaces:
java.lang.Cloneable
Direct Known Subclasses:
IconStyle, LabelStyle, LineStyle, PolyStyle

public abstract class ColorStyle
extends SubStyle
implements java.lang.Cloneable

This is an abstract element and cannot be used directly in a KML file. It provides elements for specifying the color and color mode of extended style types.

Syntax:
<!-- abstract element; do not create -->
 <!-- ColorStyle id="ID" -->          <!-- IconStyle,LabelStyle,LineStyle,PolyStyle -->
   <color>ffffffff</color>            <!-- kml:color -->
   <colorMode>normal</colorMode>      <!-- kml:colorModeEnum: normal or random -->
 <!-- /ColorStyle -->
Extends:


Field Summary
protected  java.lang.String color
          
protected  ColorMode colorMode
          ColorMode
protected  java.util.List<AbstractObject> colorStyleObjectExtension
          
protected  java.util.List<java.lang.Object> 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
ColorStyle()
           
 
Method Summary
 ColorStyle addToColorStyleObjectExtension(AbstractObject colorStyleObjectExtension)
          add a value to the colorStyleObjectExtension property collection
 ColorStyle addToColorStyleSimpleExtension(java.lang.Object colorStyleSimpleExtension)
          add a value to the colorStyleSimpleExtension property collection
 ColorStyle addToObjectSimpleExtension(java.lang.Object objectSimpleExtension)
          add a value to the objectSimpleExtension property collection
 ColorStyle addToSubStyleObjectExtension(AbstractObject subStyleObjectExtension)
          add a value to the subStyleObjectExtension property collection
 ColorStyle addToSubStyleSimpleExtension(java.lang.Object subStyleSimpleExtension)
          add a value to the subStyleSimpleExtension property collection
 ColorStyle clone()
           
 boolean equals(java.lang.Object obj)
           
 java.lang.String getColor()
           
 ColorMode getColorMode()
           
 java.util.List<AbstractObject> getColorStyleObjectExtension()
           
 java.util.List<java.lang.Object> getColorStyleSimpleExtension()
           
 int hashCode()
           
 void setColor(java.lang.String value)
           
 void setColorMode(ColorMode value)
           
 void setColorStyleObjectExtension(java.util.List<AbstractObject> colorStyleObjectExtension)
           
 void setColorStyleSimpleExtension(java.util.List<java.lang.Object> colorStyleSimpleExtension)
           
 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.
 ColorStyle withColor(java.lang.String color)
          fluent setter
 ColorStyle withColorMode(ColorMode colorMode)
          fluent setter
 ColorStyle withColorStyleObjectExtension(java.util.List<AbstractObject> colorStyleObjectExtension)
          fluent setter
 ColorStyle withColorStyleSimpleExtension(java.util.List<java.lang.Object> colorStyleSimpleExtension)
          fluent setter
 ColorStyle withId(java.lang.String id)
          fluent setter
 ColorStyle withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
          fluent setter
 ColorStyle withSubStyleObjectExtension(java.util.List<AbstractObject> subStyleObjectExtension)
          fluent setter
 ColorStyle withSubStyleSimpleExtension(java.util.List<java.lang.Object> subStyleSimpleExtension)
          fluent setter
 ColorStyle withTargetId(java.lang.String targetId)
          fluent setter
 
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

color

protected java.lang.String color

Color and opacity (alpha) values are expressed in hexadecimal notation. The range of values for any one color is 0 to 255 (00 to ff). For alpha, 00 is fully transparent and ff is fully opaque. The order of expression is aabbggrr, where aa=alpha (00 to ff); bb=blue (00 to ff); gg=green (00 to ff); rr=red (00 to ff). For example, if you want to apply a blue color with 50 percent opacity to an overlay, you would specify the following: 7fff0000, where alpha=0x7f, blue=0xff, green=0x00, and red=0x00.

Color values are expressed in hexadecimal notation, including opacity (alpha) values. The order of expression is alpha, blue, green, red (aabbggrr). The range of values for any one color is 0 to 255 (00 to ff). For opacity, 00 is fully transparent and ff is fully opaque. For example, if you want to apply a blue color with 50 percent opacity to an overlay, you would specify the following: 7fff0000

Note: The element has been deprecated. Use instead.


colorMode

protected ColorMode colorMode
ColorMode

normal, random

See Also: See any element that extends


colorStyleSimpleExtension

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

colorStyleObjectExtension

protected java.util.List<AbstractObject> colorStyleObjectExtension

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

ColorStyle

public ColorStyle()
Method Detail

getColor

public java.lang.String getColor()
Returns:
possible object is String
See Also:
color

setColor

public void setColor(java.lang.String value)
Parameters:
value - allowed object is String
See Also:
color

getColorMode

public ColorMode getColorMode()
Returns:
possible object is ColorMode
See Also:
colorMode

setColorMode

public void setColorMode(ColorMode value)
Parameters:
value - allowed object is ColorMode
See Also:
colorMode

getColorStyleSimpleExtension

public java.util.List<java.lang.Object> getColorStyleSimpleExtension()
See Also:
colorStyleSimpleExtension

getColorStyleObjectExtension

public java.util.List<AbstractObject> getColorStyleObjectExtension()
See Also:
colorStyleObjectExtension

hashCode

public int hashCode()
Overrides:
hashCode in class SubStyle

equals

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

setColorStyleSimpleExtension

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

addToColorStyleSimpleExtension

public ColorStyle addToColorStyleSimpleExtension(java.lang.Object colorStyleSimpleExtension)
add a value to the colorStyleSimpleExtension property collection

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)
Parameters:
colorStyleObjectExtension -
See Also:
colorStyleObjectExtension

addToColorStyleObjectExtension

public ColorStyle addToColorStyleObjectExtension(AbstractObject colorStyleObjectExtension)
add a value to the colorStyleObjectExtension property collection

Parameters:
colorStyleObjectExtension - 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 SubStyle
See Also:
objectSimpleExtension

addToObjectSimpleExtension

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

Overrides:
addToObjectSimpleExtension in class SubStyle
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 SubStyle
See Also:
subStyleSimpleExtension

addToSubStyleSimpleExtension

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

Overrides:
addToSubStyleSimpleExtension in class SubStyle
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 SubStyle
See Also:
subStyleObjectExtension

addToSubStyleObjectExtension

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

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

withColor

public ColorStyle withColor(java.lang.String color)
fluent setter

Parameters:
color - required parameter
See Also:
setColor(String)

withColorMode

public ColorStyle withColorMode(ColorMode colorMode)
fluent setter

Parameters:
colorMode - required parameter
See Also:
setColorMode(ColorMode)

withColorStyleSimpleExtension

public ColorStyle withColorStyleSimpleExtension(java.util.List<java.lang.Object> colorStyleSimpleExtension)
fluent setter

Parameters:
colorStyleSimpleExtension - required parameter
See Also:
#setColorStyleSimpleExtension(List)

withColorStyleObjectExtension

public ColorStyle withColorStyleObjectExtension(java.util.List<AbstractObject> colorStyleObjectExtension)
fluent setter

Parameters:
colorStyleObjectExtension - required parameter
See Also:
#setColorStyleObjectExtension(List)

withObjectSimpleExtension

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

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

withId

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

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

withTargetId

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

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

withSubStyleSimpleExtension

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

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

withSubStyleObjectExtension

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

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

clone

public ColorStyle clone()
Overrides:
clone in class SubStyle