de.micromata.opengis.kml.v_2_2_0
Class BalloonStyle

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

public class BalloonStyle
extends SubStyle
implements java.lang.Cloneable

Specifies how the description balloon for placemarks is drawn. The , if specified, is used as the background color of the balloon. See for a diagram illustrating how the default description balloon appears in Google Earth.

Syntax:
<BalloonStyle id="ID">
   <!-- specific to BalloonStyle -->
   <bgColor>ffffffff</bgColor>            <!-- kml:color -->
   <textColor>ff000000</textColor>        <!-- kml:color --> 
   <text>...</text>                       <!-- string -->
   <displayMode>default</displayMode>     <!-- kml:displayModeEnum -->
 </BalloonStyle>
Extends:


Field Summary
protected  java.util.List<AbstractObject> balloonStyleObjectExtension
          
protected  java.util.List<java.lang.Object> balloonStyleSimpleExtension
           
protected  java.lang.String bgColor
          
protected  java.lang.String color
          Deprecated. 
protected  DisplayMode displayMode
          DisplayMode
protected  java.lang.String text
          
protected  java.lang.String textColor
          
 
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
BalloonStyle()
           
 
Method Summary
 BalloonStyle addToBalloonStyleObjectExtension(AbstractObject balloonStyleObjectExtension)
          add a value to the balloonStyleObjectExtension property collection
 BalloonStyle addToBalloonStyleSimpleExtension(java.lang.Object balloonStyleSimpleExtension)
          add a value to the balloonStyleSimpleExtension property collection
 BalloonStyle addToObjectSimpleExtension(java.lang.Object objectSimpleExtension)
          add a value to the objectSimpleExtension property collection
 BalloonStyle addToSubStyleObjectExtension(AbstractObject subStyleObjectExtension)
          add a value to the subStyleObjectExtension property collection
 BalloonStyle addToSubStyleSimpleExtension(java.lang.Object subStyleSimpleExtension)
          add a value to the subStyleSimpleExtension property collection
 BalloonStyle clone()
           
 boolean equals(java.lang.Object obj)
           
 java.util.List<AbstractObject> getBalloonStyleObjectExtension()
           
 java.util.List<java.lang.Object> getBalloonStyleSimpleExtension()
           
 java.lang.String getBgColor()
           
 java.lang.String getColor()
           
 DisplayMode getDisplayMode()
           
 java.lang.String getText()
           
 java.lang.String getTextColor()
           
 int hashCode()
           
 void setBalloonStyleObjectExtension(java.util.List<AbstractObject> balloonStyleObjectExtension)
           
 void setBalloonStyleSimpleExtension(java.util.List<java.lang.Object> balloonStyleSimpleExtension)
           
 void setBgColor(java.lang.String value)
           
 void setColor(java.lang.String value)
           
 void setDisplayMode(DisplayMode value)
           
 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 setText(java.lang.String value)
           
 void setTextColor(java.lang.String value)
           
 BalloonStyle withBalloonStyleObjectExtension(java.util.List<AbstractObject> balloonStyleObjectExtension)
          fluent setter
 BalloonStyle withBalloonStyleSimpleExtension(java.util.List<java.lang.Object> balloonStyleSimpleExtension)
          fluent setter
 BalloonStyle withBgColor(java.lang.String bgColor)
          fluent setter
 BalloonStyle withColor(java.lang.String color)
          fluent setter
 BalloonStyle withDisplayMode(DisplayMode displayMode)
          fluent setter
 BalloonStyle withId(java.lang.String id)
          fluent setter
 BalloonStyle withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
          fluent setter
 BalloonStyle withSubStyleObjectExtension(java.util.List<AbstractObject> subStyleObjectExtension)
          fluent setter
 BalloonStyle withSubStyleSimpleExtension(java.util.List<java.lang.Object> subStyleSimpleExtension)
          fluent setter
 BalloonStyle withTargetId(java.lang.String targetId)
          fluent setter
 BalloonStyle withText(java.lang.String text)
          fluent setter
 BalloonStyle withTextColor(java.lang.String textColor)
          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

@Deprecated
protected java.lang.String color
Deprecated. 

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.


bgColor

protected java.lang.String bgColor

Background color for the Snippet. Color and opacity 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.

Background color of the balloon (optional). 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). 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 alpha, 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, where alpha=0x7f, blue=0xff, green=0x00, and red=0x00. The default is opaque white (ffffffff).

Note: The use of the element within has been deprecated. Use instead.


textColor

protected java.lang.String textColor

Foreground color for text. The default is black (ff000000).


text

protected java.lang.String text

For example, in the following KML excerpt, $[name] and $[description] fields will be replaced by the and fields found in the Feature elements that use this BalloonStyle: This is $[name], whose description is:
$[description]

Text displayed in the balloon. If no text is specified, Google Earth draws the default balloon (with the Feature in boldface, the Feature , links for driving directions, a white background, and a tail that is attached to the point coordinates of the Feature, if specified).

You can add entities to the tag using the following format to refer to a child element of Feature: $[name], $[description], $[address], $[id], $[Snippet]. Google Earth looks in the current Feature for the corresponding string entity and substitutes that information in the balloon. To include To here - From here driving directions in the balloon, use the $[geDirections] tag. To prevent the driving directions links from appearing in a balloon, include the element with some content, or with $[description] to substitute the basic Feature .


displayMode

protected DisplayMode displayMode
DisplayMode

default, hide

See Also: See


balloonStyleSimpleExtension

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

balloonStyleObjectExtension

protected java.util.List<AbstractObject> balloonStyleObjectExtension

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

BalloonStyle

public BalloonStyle()
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

getBgColor

public java.lang.String getBgColor()
Returns:
possible object is String
See Also:
bgColor

setBgColor

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

getTextColor

public java.lang.String getTextColor()
Returns:
possible object is String
See Also:
textColor

setTextColor

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

getText

public java.lang.String getText()
Returns:
possible object is String
See Also:
text

setText

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

getDisplayMode

public DisplayMode getDisplayMode()
Returns:
possible object is DisplayMode
See Also:
displayMode

setDisplayMode

public void setDisplayMode(DisplayMode value)
Parameters:
value - allowed object is DisplayMode
See Also:
displayMode

getBalloonStyleSimpleExtension

public java.util.List<java.lang.Object> getBalloonStyleSimpleExtension()
See Also:
balloonStyleSimpleExtension

getBalloonStyleObjectExtension

public java.util.List<AbstractObject> getBalloonStyleObjectExtension()
See Also:
balloonStyleObjectExtension

hashCode

public int hashCode()
Overrides:
hashCode in class SubStyle

equals

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

setBalloonStyleSimpleExtension

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

addToBalloonStyleSimpleExtension

public BalloonStyle addToBalloonStyleSimpleExtension(java.lang.Object balloonStyleSimpleExtension)
add a value to the balloonStyleSimpleExtension property collection

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

setBalloonStyleObjectExtension

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

addToBalloonStyleObjectExtension

public BalloonStyle addToBalloonStyleObjectExtension(AbstractObject balloonStyleObjectExtension)
add a value to the balloonStyleObjectExtension property collection

Parameters:
balloonStyleObjectExtension - 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 BalloonStyle 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 BalloonStyle 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 BalloonStyle 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 BalloonStyle withColor(java.lang.String color)
fluent setter

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

withBgColor

public BalloonStyle withBgColor(java.lang.String bgColor)
fluent setter

Parameters:
bgColor - required parameter
See Also:
setBgColor(String)

withTextColor

public BalloonStyle withTextColor(java.lang.String textColor)
fluent setter

Parameters:
textColor - required parameter
See Also:
setTextColor(String)

withText

public BalloonStyle withText(java.lang.String text)
fluent setter

Parameters:
text - required parameter
See Also:
setText(String)

withDisplayMode

public BalloonStyle withDisplayMode(DisplayMode displayMode)
fluent setter

Parameters:
displayMode - required parameter
See Also:
setDisplayMode(DisplayMode)

withBalloonStyleSimpleExtension

public BalloonStyle withBalloonStyleSimpleExtension(java.util.List<java.lang.Object> balloonStyleSimpleExtension)
fluent setter

Parameters:
balloonStyleSimpleExtension - required parameter
See Also:
#setBalloonStyleSimpleExtension(List)

withBalloonStyleObjectExtension

public BalloonStyle withBalloonStyleObjectExtension(java.util.List<AbstractObject> balloonStyleObjectExtension)
fluent setter

Parameters:
balloonStyleObjectExtension - required parameter
See Also:
#setBalloonStyleObjectExtension(List)

withObjectSimpleExtension

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