de.micromata.opengis.kml.v_2_2_0
Class LabelStyle

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.LabelStyle
All Implemented Interfaces:
java.lang.Cloneable

public class LabelStyle
extends ColorStyle
implements java.lang.Cloneable

Note: The tag is deprecated. Use instead.

Specifies how the of a Feature is drawn in the 3D viewer. A custom color, color mode, and scale for the label (name) can be specified.

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


Field Summary
protected  java.util.List<AbstractObject> labelStyleObjectExtension
          
protected  java.util.List<java.lang.Object> labelStyleSimpleExtension
           
protected  double scale
          
 
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
LabelStyle()
           
 
Method Summary
 LabelStyle addToColorStyleObjectExtension(AbstractObject colorStyleObjectExtension)
          add a value to the colorStyleObjectExtension property collection
 LabelStyle addToColorStyleSimpleExtension(java.lang.Object colorStyleSimpleExtension)
          add a value to the colorStyleSimpleExtension property collection
 LabelStyle addToLabelStyleObjectExtension(AbstractObject labelStyleObjectExtension)
          add a value to the labelStyleObjectExtension property collection
 LabelStyle addToLabelStyleSimpleExtension(java.lang.Object labelStyleSimpleExtension)
          add a value to the labelStyleSimpleExtension property collection
 LabelStyle addToObjectSimpleExtension(java.lang.Object objectSimpleExtension)
          add a value to the objectSimpleExtension property collection
 LabelStyle addToSubStyleObjectExtension(AbstractObject subStyleObjectExtension)
          add a value to the subStyleObjectExtension property collection
 LabelStyle addToSubStyleSimpleExtension(java.lang.Object subStyleSimpleExtension)
          add a value to the subStyleSimpleExtension property collection
 LabelStyle clone()
           
 boolean equals(java.lang.Object obj)
           
 java.util.List<AbstractObject> getLabelStyleObjectExtension()
           
 java.util.List<java.lang.Object> getLabelStyleSimpleExtension()
           
 double getScale()
           
 int hashCode()
           
 void setColorStyleObjectExtension(java.util.List<AbstractObject> colorStyleObjectExtension)
           
 void setColorStyleSimpleExtension(java.util.List<java.lang.Object> colorStyleSimpleExtension)
           
 void setLabelStyleObjectExtension(java.util.List<AbstractObject> labelStyleObjectExtension)
           
 void setLabelStyleSimpleExtension(java.util.List<java.lang.Object> labelStyleSimpleExtension)
           
 void setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
           
 void setScale(double value)
           
 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.
 LabelStyle withColor(java.lang.String color)
          fluent setter
 LabelStyle withColorMode(ColorMode colorMode)
          fluent setter
 LabelStyle withColorStyleObjectExtension(java.util.List<AbstractObject> colorStyleObjectExtension)
          fluent setter
 LabelStyle withColorStyleSimpleExtension(java.util.List<java.lang.Object> colorStyleSimpleExtension)
          fluent setter
 LabelStyle withId(java.lang.String id)
          fluent setter
 LabelStyle withLabelStyleObjectExtension(java.util.List<AbstractObject> labelStyleObjectExtension)
          fluent setter
 LabelStyle withLabelStyleSimpleExtension(java.util.List<java.lang.Object> labelStyleSimpleExtension)
          fluent setter
 LabelStyle withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
          fluent setter
 LabelStyle withScale(double scale)
          fluent setter
 LabelStyle withSubStyleObjectExtension(java.util.List<AbstractObject> subStyleObjectExtension)
          fluent setter
 LabelStyle withSubStyleSimpleExtension(java.util.List<java.lang.Object> subStyleSimpleExtension)
          fluent setter
 LabelStyle withTargetId(java.lang.String targetId)
          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

scale

protected double scale

Note: The tag has been deprecated. Use instead.

Resizes the icon.

Scales a model along the x, y, and z axes in the model's coordinate space. 2.5 2.5 3.5


labelStyleSimpleExtension

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

labelStyleObjectExtension

protected java.util.List<AbstractObject> labelStyleObjectExtension

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

LabelStyle

public LabelStyle()
Method Detail

getScale

public double getScale()
Returns:
possible object is Double
See Also:
scale

setScale

public void setScale(double value)
Parameters:
value - allowed object is Double
See Also:
scale

getLabelStyleSimpleExtension

public java.util.List<java.lang.Object> getLabelStyleSimpleExtension()
See Also:
labelStyleSimpleExtension

getLabelStyleObjectExtension

public java.util.List<AbstractObject> getLabelStyleObjectExtension()
See Also:
labelStyleObjectExtension

hashCode

public int hashCode()
Overrides:
hashCode in class ColorStyle

equals

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

setLabelStyleSimpleExtension

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

addToLabelStyleSimpleExtension

public LabelStyle addToLabelStyleSimpleExtension(java.lang.Object labelStyleSimpleExtension)
add a value to the labelStyleSimpleExtension property collection

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

setLabelStyleObjectExtension

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

addToLabelStyleObjectExtension

public LabelStyle addToLabelStyleObjectExtension(AbstractObject labelStyleObjectExtension)
add a value to the labelStyleObjectExtension property collection

Parameters:
labelStyleObjectExtension - 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 LabelStyle 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 LabelStyle 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 LabelStyle 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 LabelStyle 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 LabelStyle 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).

withScale

public LabelStyle withScale(double scale)
fluent setter

Parameters:
scale - required parameter
See Also:
setScale(double)

withLabelStyleSimpleExtension

public LabelStyle withLabelStyleSimpleExtension(java.util.List<java.lang.Object> labelStyleSimpleExtension)
fluent setter

Parameters:
labelStyleSimpleExtension - required parameter
See Also:
#setLabelStyleSimpleExtension(List)

withLabelStyleObjectExtension

public LabelStyle withLabelStyleObjectExtension(java.util.List<AbstractObject> labelStyleObjectExtension)
fluent setter

Parameters:
labelStyleObjectExtension - required parameter
See Also:
#setLabelStyleObjectExtension(List)

withObjectSimpleExtension

public LabelStyle 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 LabelStyle 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 LabelStyle 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 LabelStyle 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 LabelStyle 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 LabelStyle 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 LabelStyle 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 LabelStyle 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 LabelStyle 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 LabelStyle clone()
Overrides:
clone in class ColorStyle