BalloonStyle (a Java API for Kml 2.2.1 API)

java.lang.Object
- de.micromata.opengis.kml.v_2_2_0.AbstractObject
- - de.micromata.opengis.kml.v_2_2_0.SubStyle
  - - de.micromata.opengis.kml.v_2_2_0.BalloonStyle

All Implemented Interfaces:: Cloneable

public class BalloonStyle
extends SubStyle
implements 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

Fields
Modifier and Type	Field and Description
`protected List<AbstractObject>`	`balloonStyleObjectExtension`
`protected List<Object>`	`balloonStyleSimpleExtension`
`protected String`	`bgColor` Background color for the Snippet.
`protected String`	`color` Deprecated.
`protected DisplayMode`	`displayMode` DisplayMode default, hide See Also: See
`protected 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.
`protected String`	`textColor` Foreground color for text.

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

Constructors
Constructor and Description

BalloonStyle()

Constructors
Constructor and Description
`BalloonStyle()`

Method Summary

Methods
Modifier and Type	Method and Description
`BalloonStyle`	`addToBalloonStyleObjectExtension(AbstractObject balloonStyleObjectExtension)` add a value to the balloonStyleObjectExtension property collection
`BalloonStyle`	`addToBalloonStyleSimpleExtension(Object balloonStyleSimpleExtension)` add a value to the balloonStyleSimpleExtension property collection
`BalloonStyle`	`addToObjectSimpleExtension(Object objectSimpleExtension)` add a value to the objectSimpleExtension property collection
`BalloonStyle`	`addToSubStyleObjectExtension(AbstractObject subStyleObjectExtension)` add a value to the subStyleObjectExtension property collection
`BalloonStyle`	`addToSubStyleSimpleExtension(Object subStyleSimpleExtension)` add a value to the subStyleSimpleExtension property collection
`BalloonStyle`	`clone()`
`boolean`	`equals(Object obj)`
`List<AbstractObject>`	`getBalloonStyleObjectExtension()`
`List<Object>`	`getBalloonStyleSimpleExtension()`
`String`	`getBgColor()`
`String`	`getColor()`
`DisplayMode`	`getDisplayMode()`
`String`	`getText()`
`String`	`getTextColor()`
`int`	`hashCode()`
`void`	`setBalloonStyleObjectExtension(List<AbstractObject> balloonStyleObjectExtension)`
`void`	`setBalloonStyleSimpleExtension(List<Object> balloonStyleSimpleExtension)`
`void`	`setBgColor(String value)`
`void`	`setColor(String value)`
`void`	`setDisplayMode(DisplayMode value)`
`void`	`setObjectSimpleExtension(List<Object> objectSimpleExtension)`
`void`	`setSubStyleObjectExtension(List<AbstractObject> subStyleObjectExtension)` Sets the value of the subStyleObjectExtension property Objects of the following type(s) are allowed in the list List.
`void`	`setSubStyleSimpleExtension(List<Object> subStyleSimpleExtension)` Sets the value of the subStyleSimpleExtension property Objects of the following type(s) are allowed in the list List
`void`	`setText(String value)`
`void`	`setTextColor(String value)`
`BalloonStyle`	`withBalloonStyleObjectExtension(List<AbstractObject> balloonStyleObjectExtension)` fluent setter
`BalloonStyle`	`withBalloonStyleSimpleExtension(List<Object> balloonStyleSimpleExtension)` fluent setter
`BalloonStyle`	`withBgColor(String bgColor)` fluent setter
`BalloonStyle`	`withColor(String color)` fluent setter
`BalloonStyle`	`withDisplayMode(DisplayMode displayMode)` fluent setter
`BalloonStyle`	`withId(String id)` fluent setter
`BalloonStyle`	`withObjectSimpleExtension(List<Object> objectSimpleExtension)` fluent setter
`BalloonStyle`	`withSubStyleObjectExtension(List<AbstractObject> subStyleObjectExtension)` fluent setter
`BalloonStyle`	`withSubStyleSimpleExtension(List<Object> subStyleSimpleExtension)` fluent setter
`BalloonStyle`	`withTargetId(String targetId)` fluent setter
`BalloonStyle`	`withText(String text)` fluent setter
`BalloonStyle`	`withTextColor(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 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 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 String textColor
```
    Foreground color for text. The default is black (ff000000).
  - text
```
protected 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 List<Object> balloonStyleSimpleExtension
```
  - balloonStyleObjectExtension
```
protected 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:
      
    
    Constructor Detail
    
    BalloonStyle
    
    public BalloonStyle()
    
    Method Detail
    
    getColor
    
    public String getColor()
    
    Returns:
    possible object is String
    See Also:
    color
    
    setColor
    
    public void setColor(String value)
    
    Parameters:
    value - allowed object is String
    See Also:
    color
    
    getBgColor
    
    public String getBgColor()
    
    Returns:
    possible object is String
    See Also:
    bgColor
    
    setBgColor
    
    public void setBgColor(String value)
    
    Parameters:
    value - allowed object is String
    See Also:
    bgColor
    
    getTextColor
    
    public String getTextColor()
    
    Returns:
    possible object is String
    See Also:
    textColor
    
    setTextColor
    
    public void setTextColor(String value)
    
    Parameters:
    value - allowed object is String
    See Also:
    textColor
    
    getText
    
    public String getText()
    
    Returns:
    possible object is String
    See Also:
    text
    
    setText
    
    public void setText(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 List<Object> getBalloonStyleSimpleExtension()
    
    See Also:
    balloonStyleSimpleExtension
    
    getBalloonStyleObjectExtension
    
    public List<AbstractObject> getBalloonStyleObjectExtension()
    
    See Also:
    balloonStyleObjectExtension
    
    hashCode
    
    public int hashCode()
    
    Overrides:
    
    hashCode in class SubStyle
    
    equals
    
    public boolean equals(Object obj)
    
    Overrides:
    
    equals in class SubStyle
    
    setBalloonStyleSimpleExtension
    
    public void setBalloonStyleSimpleExtension(List<Object> balloonStyleSimpleExtension)
    
    Parameters:
    balloonStyleSimpleExtension -
    See Also:
    balloonStyleSimpleExtension
    
    addToBalloonStyleSimpleExtension
    
    public BalloonStyle addToBalloonStyleSimpleExtension(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(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(List<Object> objectSimpleExtension)
    
    Overrides:
    
    setObjectSimpleExtension in class SubStyle
    
    See Also:
    objectSimpleExtension
    
    addToObjectSimpleExtension
    
    public BalloonStyle addToObjectSimpleExtension(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(List<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

Class BalloonStyle

Field Summary

Fields inherited from class de.micromata.opengis.kml.v_2_2_0.SubStyle

Fields inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject

Constructor Summary

Method Summary

Methods inherited from class de.micromata.opengis.kml.v_2_2_0.SubStyle

Methods inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject

Methods inherited from class java.lang.Object

Field Detail

color

bgColor

textColor

text

displayMode

balloonStyleSimpleExtension

balloonStyleObjectExtension

Constructor Detail

BalloonStyle

Method Detail

getColor

setColor

getBgColor

setBgColor

getTextColor

setTextColor

getText

setText

getDisplayMode

setDisplayMode

getBalloonStyleSimpleExtension

getBalloonStyleObjectExtension

hashCode

equals

setBalloonStyleSimpleExtension

addToBalloonStyleSimpleExtension

setBalloonStyleObjectExtension

addToBalloonStyleObjectExtension

setObjectSimpleExtension

addToObjectSimpleExtension

setSubStyleSimpleExtension

addToSubStyleSimpleExtension

setSubStyleObjectExtension

addToSubStyleObjectExtension

withColor

withBgColor

withTextColor

withText

withDisplayMode

withBalloonStyleSimpleExtension

withBalloonStyleObjectExtension

withObjectSimpleExtension

withId

withTargetId

withSubStyleSimpleExtension

withSubStyleObjectExtension

clone