de.micromata.opengis.kml.v_2_2_0
Class ScreenOverlay

java.lang.Object
  extended by de.micromata.opengis.kml.v_2_2_0.AbstractObject
      extended by de.micromata.opengis.kml.v_2_2_0.Feature
          extended by de.micromata.opengis.kml.v_2_2_0.Overlay
              extended by de.micromata.opengis.kml.v_2_2_0.ScreenOverlay
All Implemented Interfaces:
java.lang.Cloneable

public class ScreenOverlay
extends Overlay
implements java.lang.Cloneable

The child of specifies the image to be used as the overlay. This file can be either on a local file system or on a web server. If this element is omitted or contains no , a rectangle is drawn using the color and size defined by the screen overlay.

This element draws an image overlay fixed to the screen. Sample uses for ScreenOverlays are compasses, logos, and heads-up displays. ScreenOverlay sizing is determined by the element. Positioning of the overlay is handled by mapping a point in the image specified by to a point on the screen specified by . Then the image is rotated by degrees about a point relative to the screen specified by .

This element draws an image overlay fixed to the screen. Sample uses for ScreenOverlays are compasses, logos, and heads-up displays. ScreenOverlay sizing is determined by the element. Positioning of the overlay is handled by mapping a point in the image specified by to a point on the screen specified by . Then the image is rotated by degrees about a point relative to the screen specified by .

Syntax:
<ScreenOverlay id="ID">
   <!-- inherited from Feature element -->
   <name>...</name>                      <!-- string -->
   <visibility>1</visibility>            <!-- boolean -->
   <open>0</open>                        <!-- boolean -->
   <atom:author>...<atom:author>         <!-- xmlns:atom -->
   <atom:link>...</atom:link>            <!-- xmlns:atom -->
   <address>...</address>                <!-- string -->
   <xal:AddressDetails>...</xal:AddressDetails>  <!-- xmlns:xal -->
<phoneNumber>...</phoneNumber> <!-- string -->
<Snippet maxLines="2">...</Snippet> <!-- string --> <description>...</description> <!-- string --> <AbstractView>...</AbstractView> <!-- Camera or LookAt --> <TimePrimitive>...</TimePrimitive> <styleUrl>...</styleUrl> <!-- anyURI --> <StyleSelector>...</StyleSelector> <Region>...</Region> <Metadata>...</Metadata> <!-- deprecated in KML 2.2 --> <ExtendedData>...</ExtendedData> <!-- new in KML 2.2 --> <!-- inherited from Overlay element --> <color>ffffffff</color> <!-- kml:color --> <drawOrder>0</drawOrder> <!-- int --> <Icon>...</Icon> <!-- specific to ScreenOverlay --> <overlayXY x="double" y="double" xunits="fraction" yunits="fraction"/> <!-- vec2 --> <!-- xunits and yunits can be one of: fraction, pixels, or insetPixels --> <screenXY x="double" y="double" xunits="fraction" yunits="fraction"/> <!-- vec2 --> <rotationXY x="double" y="double" xunits="fraction" yunits"fraction"/> <!-- vec2 --> <size x="double" y="double" xunits="fraction" yunits="fraction"/> <!-- vec2 --> <rotation>0</rotation> <!-- float --> </ScreenOverlay>
Extends:


Field Summary
protected  Vec2 overlayXY
          
protected  double rotation
          
protected  Vec2 rotationXY
          
protected  java.util.List<AbstractObject> screenOverlayObjectExtension
          
protected  java.util.List<java.lang.Object> screenOverlaySimpleExtension
           
protected  Vec2 screenXY
          
protected  Vec2 size
          
 
Fields inherited from class de.micromata.opengis.kml.v_2_2_0.Overlay
color, drawOrder, icon, overlayObjectExtension, overlaySimpleExtension
 
Fields inherited from class de.micromata.opengis.kml.v_2_2_0.Feature
abstractView, address, atomAuthor, atomLink, description, extendedData, featureObjectExtension, featureSimpleExtension, metadata, name, open, phoneNumber, region, snippet, snippetd, styleSelector, styleUrl, timePrimitive, visibility, xalAddressDetails
 
Fields inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject
id, objectSimpleExtension, targetId
 
Constructor Summary
ScreenOverlay()
           
 
Method Summary
 ScreenOverlay addToFeatureObjectExtension(AbstractObject featureObjectExtension)
          add a value to the featureObjectExtension property collection
 ScreenOverlay addToFeatureSimpleExtension(java.lang.Object featureSimpleExtension)
          add a value to the featureSimpleExtension property collection
 ScreenOverlay addToObjectSimpleExtension(java.lang.Object objectSimpleExtension)
          add a value to the objectSimpleExtension property collection
 ScreenOverlay addToOverlayObjectExtension(AbstractObject overlayObjectExtension)
          add a value to the overlayObjectExtension property collection
 ScreenOverlay addToOverlaySimpleExtension(java.lang.Object overlaySimpleExtension)
          add a value to the overlaySimpleExtension property collection
 ScreenOverlay addToScreenOverlayObjectExtension(AbstractObject screenOverlayObjectExtension)
          add a value to the screenOverlayObjectExtension property collection
 ScreenOverlay addToScreenOverlaySimpleExtension(java.lang.Object screenOverlaySimpleExtension)
          add a value to the screenOverlaySimpleExtension property collection
 ScreenOverlay addToStyleSelector(StyleSelector styleSelector)
          add a value to the styleSelector property collection
 ScreenOverlay clone()
           
 Vec2 createAndSetOverlayXY()
          Creates a new instance of Vec2 and set it to overlayXY.
 Vec2 createAndSetRotationXY()
          Creates a new instance of Vec2 and set it to rotationXY.
 Vec2 createAndSetScreenXY()
          Creates a new instance of Vec2 and set it to screenXY.
 Vec2 createAndSetSize()
          Creates a new instance of Vec2 and set it to size.
 boolean equals(java.lang.Object obj)
           
 Vec2 getOverlayXY()
           
 double getRotation()
           
 Vec2 getRotationXY()
           
 java.util.List<AbstractObject> getScreenOverlayObjectExtension()
           
 java.util.List<java.lang.Object> getScreenOverlaySimpleExtension()
           
 Vec2 getScreenXY()
           
 Vec2 getSize()
           
 int hashCode()
           
 void setFeatureObjectExtension(java.util.List<AbstractObject> featureObjectExtension)
           
 void setFeatureSimpleExtension(java.util.List<java.lang.Object> featureSimpleExtension)
           
 void setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
           
 void setOverlayObjectExtension(java.util.List<AbstractObject> overlayObjectExtension)
           
 void setOverlaySimpleExtension(java.util.List<java.lang.Object> overlaySimpleExtension)
           
 void setOverlayXY(Vec2 value)
           
 void setRotation(double value)
           
 void setRotationXY(Vec2 value)
           
 void setScreenOverlayObjectExtension(java.util.List<AbstractObject> screenOverlayObjectExtension)
           
 void setScreenOverlaySimpleExtension(java.util.List<java.lang.Object> screenOverlaySimpleExtension)
           
 void setScreenXY(Vec2 value)
           
 void setSize(Vec2 value)
           
 void setStyleSelector(java.util.List<StyleSelector> styleSelector)
           
 ScreenOverlay withAbstractView(AbstractView abstractView)
          fluent setter
 ScreenOverlay withAddress(java.lang.String address)
          fluent setter
 ScreenOverlay withAtomAuthor(Author atomAuthor)
          fluent setter
 ScreenOverlay withAtomLink(Link atomLink)
          fluent setter
 ScreenOverlay withColor(java.lang.String color)
          fluent setter
 ScreenOverlay withDescription(java.lang.String description)
          fluent setter
 ScreenOverlay withDrawOrder(int drawOrder)
          fluent setter
 ScreenOverlay withExtendedData(ExtendedData extendedData)
          fluent setter
 ScreenOverlay withFeatureObjectExtension(java.util.List<AbstractObject> featureObjectExtension)
          fluent setter
 ScreenOverlay withFeatureSimpleExtension(java.util.List<java.lang.Object> featureSimpleExtension)
          fluent setter
 ScreenOverlay withIcon(Icon icon)
          fluent setter
 ScreenOverlay withId(java.lang.String id)
          fluent setter
 ScreenOverlay withMetadata(Metadata metadata)
          fluent setter
 ScreenOverlay withName(java.lang.String name)
          fluent setter
 ScreenOverlay withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
          fluent setter
 ScreenOverlay withOpen(java.lang.Boolean open)
          fluent setter
 ScreenOverlay withOverlayObjectExtension(java.util.List<AbstractObject> overlayObjectExtension)
          fluent setter
 ScreenOverlay withOverlaySimpleExtension(java.util.List<java.lang.Object> overlaySimpleExtension)
          fluent setter
 ScreenOverlay withOverlayXY(Vec2 overlayXY)
          fluent setter
 ScreenOverlay withPhoneNumber(java.lang.String phoneNumber)
          fluent setter
 ScreenOverlay withRegion(Region region)
          fluent setter
 ScreenOverlay withRotation(double rotation)
          fluent setter
 ScreenOverlay withRotationXY(Vec2 rotationXY)
          fluent setter
 ScreenOverlay withScreenOverlayObjectExtension(java.util.List<AbstractObject> screenOverlayObjectExtension)
          fluent setter
 ScreenOverlay withScreenOverlaySimpleExtension(java.util.List<java.lang.Object> screenOverlaySimpleExtension)
          fluent setter
 ScreenOverlay withScreenXY(Vec2 screenXY)
          fluent setter
 ScreenOverlay withSize(Vec2 size)
          fluent setter
 ScreenOverlay withSnippet(Snippet snippet)
          fluent setter
 ScreenOverlay withSnippetd(java.lang.String snippetd)
          fluent setter
 ScreenOverlay withStyleSelector(java.util.List<StyleSelector> styleSelector)
          fluent setter
 ScreenOverlay withStyleUrl(java.lang.String styleUrl)
          fluent setter
 ScreenOverlay withTargetId(java.lang.String targetId)
          fluent setter
 ScreenOverlay withTimePrimitive(TimePrimitive timePrimitive)
          fluent setter
 ScreenOverlay withVisibility(java.lang.Boolean visibility)
          fluent setter
 ScreenOverlay withXalAddressDetails(AddressDetails xalAddressDetails)
          fluent setter
 
Methods inherited from class de.micromata.opengis.kml.v_2_2_0.Overlay
createAndSetIcon, getColor, getDrawOrder, getIcon, getOverlayObjectExtension, getOverlaySimpleExtension, setColor, setDrawOrder, setIcon
 
Methods inherited from class de.micromata.opengis.kml.v_2_2_0.Feature
createAndAddStyle, createAndAddStyleMap, createAndSetAtomAuthor, createAndSetAtomLink, createAndSetCamera, createAndSetExtendedData, createAndSetLookAt, createAndSetMetadata, createAndSetRegion, createAndSetSnippet, createAndSetTimeSpan, createAndSetTimeStamp, createAndSetXalAddressDetails, getAbstractView, getAddress, getAtomAuthor, getAtomLink, getDescription, getExtendedData, getFeatureObjectExtension, getFeatureSimpleExtension, getMetadata, getName, getPhoneNumber, getRegion, getSnippet, getSnippetd, getStyleSelector, getStyleUrl, getTimePrimitive, getXalAddressDetails, isOpen, isVisibility, setAbstractView, setAddress, setAtomAuthor, setAtomLink, setDescription, setExtendedData, setMetadata, setName, setOpen, setPhoneNumber, setRegion, setSnippet, setSnippetd, setStyleUrl, setTimePrimitive, setVisibility, setXalAddressDetails
 
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

overlayXY

protected Vec2 overlayXY

Specifies a point on (or outside of) the overlay image that is mapped to the screen coordinate (). It requires x and y values, and the units for those values.

The x and y values can be specified in three different ways: as pixels ("pixels"), as fractions of the image ("fraction"), or as inset pixels ("insetPixels"), which is an offset in pixels from the upper right corner of the image. The x and y positions can be specified in different ways—for example, x can be in pixels and y can be a fraction. The origin of the coordinate system is in the lower left corner of the image. x - Either the number of pixels, a fractional component of the image, or a pixel inset indicating the x component of a point on the overlay image. y - Either the number of pixels, a fractional component of the image, or a pixel inset indicating the y component of a point on the overlay image. xunits - Units in which the x value is specified. A value of "fraction" indicates the x value is a fraction of the image. A value of "pixels" indicates the x value in pixels. A value of "insetPixels" indicates the indent from the right edge of the image. yunits - Units in which the y value is specified. A value of "fraction" indicates the y value is a fraction of the image. A value of "pixels" indicates the y value in pixels. A value of "insetPixels" indicates the indent from the top edge of the image.


screenXY

protected Vec2 screenXY

Center the image:

Center the image: Place the image on the top left: Place the image at the right of the screen:

For example, indicates a point in the middle of the screen.

Here are some examples:

Place the image at the right of the screen:

Place the image on the top left:

Specifies a point relative to the screen origin that the overlay image is mapped to. The x and y values can be specified in three different ways: as pixels ("pixels"), as fractions of the screen ("fraction"), or as inset pixels ("insetPixels"), which is an offset in pixels from the upper right corner of the screen. The x and y positions can be specified in different ways—for example, x can be in pixels and y can be a fraction. The origin of the coordinate system is in the lower left corner of the screen. x - Either the number of pixels, a fractional component of the screen, or a pixel inset indicating the x component of a point on the screen. y - Either the number of pixels, a fractional component of the screen, or a pixel inset indicating the y component of a point on the screen. xunits - Units in which the x value is specified. A value of "fraction" indicates the x value is a fraction of the screen. A value of "pixels" indicates the x value in pixels. A value of "insetPixels" indicates the indent from the right edge of the screen. yunits - Units in which the y value is specified. A value of fraction indicates the y value is a fraction of the screen. A value of "pixels" indicates the y value in pixels. A value of "insetPixels" indicates the indent from the top edge of the screen.


rotationXY

protected Vec2 rotationXY

Point relative to the screen about which the screen overlay is rotated.


size

protected Vec2 size

For example:

Specifies the size of the image for the screen overlay, as follows: A value of −1 indicates to use the native dimension A value of 0 indicates to maintain the aspect ratio A value of n sets the value of the dimension

To force the image to resize to 100px by 500px:

To force the image to retain its horizontal dimension, but to take up 20 percent of the vertical screen space:

To force the image to retain its original x and y dimensions, set the values to −1:

To force the image to retain its original x and y dimensions, set the values to −1: To force the image to retain its horizontal dimension, but to take up 20 percent of the vertical screen space: To force the image to resize to 100px by 500px:


rotation

protected double rotation

Adjusts how the photo is placed inside the field of view. This element is useful if your photo has been rotated and deviates slightly from a desired horizontal view.

Indicates the angle of rotation of the parent object. A value of 0 means no rotation. The value is an angle in degrees counterclockwise starting from north. Use ±180 to indicate the rotation of the parent object from 0. The center of the , if not (.5,.5), is specified in .


screenOverlaySimpleExtension

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

screenOverlayObjectExtension

protected java.util.List<AbstractObject> screenOverlayObjectExtension

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

ScreenOverlay

public ScreenOverlay()
Method Detail

getOverlayXY

public Vec2 getOverlayXY()
Returns:
possible object is Vec2
See Also:
overlayXY

setOverlayXY

public void setOverlayXY(Vec2 value)
Parameters:
value - allowed object is Vec2
See Also:
overlayXY

getScreenXY

public Vec2 getScreenXY()
Returns:
possible object is Vec2
See Also:
screenXY

setScreenXY

public void setScreenXY(Vec2 value)
Parameters:
value - allowed object is Vec2
See Also:
screenXY

getRotationXY

public Vec2 getRotationXY()
Returns:
possible object is Vec2
See Also:
rotationXY

setRotationXY

public void setRotationXY(Vec2 value)
Parameters:
value - allowed object is Vec2
See Also:
rotationXY

getSize

public Vec2 getSize()
Returns:
possible object is Vec2
See Also:
size

setSize

public void setSize(Vec2 value)
Parameters:
value - allowed object is Vec2
See Also:
size

getRotation

public double getRotation()
Returns:
possible object is Double
See Also:
rotation

setRotation

public void setRotation(double value)
Parameters:
value - allowed object is Double
See Also:
rotation

getScreenOverlaySimpleExtension

public java.util.List<java.lang.Object> getScreenOverlaySimpleExtension()
See Also:
screenOverlaySimpleExtension

getScreenOverlayObjectExtension

public java.util.List<AbstractObject> getScreenOverlayObjectExtension()
See Also:
screenOverlayObjectExtension

hashCode

public int hashCode()
Overrides:
hashCode in class Overlay

equals

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

createAndSetOverlayXY

public Vec2 createAndSetOverlayXY()
Creates a new instance of Vec2 and set it to overlayXY. This method is a short version for: Vec2 vec2 = new Vec2(); this.setOverlayXY(vec2);


createAndSetScreenXY

public Vec2 createAndSetScreenXY()
Creates a new instance of Vec2 and set it to screenXY. This method is a short version for: Vec2 vec2 = new Vec2(); this.setScreenXY(vec2);


createAndSetRotationXY

public Vec2 createAndSetRotationXY()
Creates a new instance of Vec2 and set it to rotationXY. This method is a short version for: Vec2 vec2 = new Vec2(); this.setRotationXY(vec2);


createAndSetSize

public Vec2 createAndSetSize()
Creates a new instance of Vec2 and set it to size. This method is a short version for: Vec2 vec2 = new Vec2(); this.setSize(vec2);


setScreenOverlaySimpleExtension

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

addToScreenOverlaySimpleExtension

public ScreenOverlay addToScreenOverlaySimpleExtension(java.lang.Object screenOverlaySimpleExtension)
add a value to the screenOverlaySimpleExtension property collection

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

setScreenOverlayObjectExtension

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

addToScreenOverlayObjectExtension

public ScreenOverlay addToScreenOverlayObjectExtension(AbstractObject screenOverlayObjectExtension)
add a value to the screenOverlayObjectExtension property collection

Parameters:
screenOverlayObjectExtension - 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 Overlay
See Also:
objectSimpleExtension

addToObjectSimpleExtension

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

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

setStyleSelector

public void setStyleSelector(java.util.List<StyleSelector> styleSelector)
Overrides:
setStyleSelector in class Overlay
See Also:
styleSelector

addToStyleSelector

public ScreenOverlay addToStyleSelector(StyleSelector styleSelector)
Description copied from class: Feature
add a value to the styleSelector property collection

Overrides:
addToStyleSelector in class Overlay
Parameters:
styleSelector - Objects of the following type are allowed in the list: <StyleSelectorJAXBElement<StyleMapJAXBElement<Style
Returns:
true (as general contract of Collection.add).

setFeatureSimpleExtension

public void setFeatureSimpleExtension(java.util.List<java.lang.Object> featureSimpleExtension)
Overrides:
setFeatureSimpleExtension in class Overlay
See Also:
featureSimpleExtension

addToFeatureSimpleExtension

public ScreenOverlay addToFeatureSimpleExtension(java.lang.Object featureSimpleExtension)
Description copied from class: Feature
add a value to the featureSimpleExtension property collection

Overrides:
addToFeatureSimpleExtension in class Overlay
Parameters:
featureSimpleExtension - Objects of the following type are allowed in the list: <ObjectJAXBElement<Boolean
Returns:
true (as general contract of Collection.add).

setFeatureObjectExtension

public void setFeatureObjectExtension(java.util.List<AbstractObject> featureObjectExtension)
Overrides:
setFeatureObjectExtension in class Overlay
See Also:
featureObjectExtension

addToFeatureObjectExtension

public ScreenOverlay addToFeatureObjectExtension(AbstractObject featureObjectExtension)
Description copied from class: Feature
add a value to the featureObjectExtension property collection

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

setOverlaySimpleExtension

public void setOverlaySimpleExtension(java.util.List<java.lang.Object> overlaySimpleExtension)
Overrides:
setOverlaySimpleExtension in class Overlay
See Also:
overlaySimpleExtension

addToOverlaySimpleExtension

public ScreenOverlay addToOverlaySimpleExtension(java.lang.Object overlaySimpleExtension)
Description copied from class: Overlay
add a value to the overlaySimpleExtension property collection

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

setOverlayObjectExtension

public void setOverlayObjectExtension(java.util.List<AbstractObject> overlayObjectExtension)
Overrides:
setOverlayObjectExtension in class Overlay
See Also:
overlayObjectExtension

addToOverlayObjectExtension

public ScreenOverlay addToOverlayObjectExtension(AbstractObject overlayObjectExtension)
Description copied from class: Overlay
add a value to the overlayObjectExtension property collection

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

withOverlayXY

public ScreenOverlay withOverlayXY(Vec2 overlayXY)
fluent setter

Parameters:
overlayXY - required parameter
See Also:
setOverlayXY(Vec2)

withScreenXY

public ScreenOverlay withScreenXY(Vec2 screenXY)
fluent setter

Parameters:
screenXY - required parameter
See Also:
setScreenXY(Vec2)

withRotationXY

public ScreenOverlay withRotationXY(Vec2 rotationXY)
fluent setter

Parameters:
rotationXY - required parameter
See Also:
setRotationXY(Vec2)

withSize

public ScreenOverlay withSize(Vec2 size)
fluent setter

Parameters:
size - required parameter
See Also:
setSize(Vec2)

withRotation

public ScreenOverlay withRotation(double rotation)
fluent setter

Parameters:
rotation - required parameter
See Also:
setRotation(double)

withScreenOverlaySimpleExtension

public ScreenOverlay withScreenOverlaySimpleExtension(java.util.List<java.lang.Object> screenOverlaySimpleExtension)
fluent setter

Parameters:
screenOverlaySimpleExtension - required parameter
See Also:
#setScreenOverlaySimpleExtension(List)

withScreenOverlayObjectExtension

public ScreenOverlay withScreenOverlayObjectExtension(java.util.List<AbstractObject> screenOverlayObjectExtension)
fluent setter

Parameters:
screenOverlayObjectExtension - required parameter
See Also:
#setScreenOverlayObjectExtension(List)

withObjectSimpleExtension

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

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

withId

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

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

withTargetId

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

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

withName

public ScreenOverlay withName(java.lang.String name)
Description copied from class: Feature
fluent setter

Overrides:
withName in class Overlay
Parameters:
name - required parameter
See Also:
Feature.setName(String)

withVisibility

public ScreenOverlay withVisibility(java.lang.Boolean visibility)
Description copied from class: Feature
fluent setter

Overrides:
withVisibility in class Overlay
Parameters:
visibility - required parameter
See Also:
Feature.setVisibility(Boolean)

withOpen

public ScreenOverlay withOpen(java.lang.Boolean open)
Description copied from class: Feature
fluent setter

Overrides:
withOpen in class Overlay
Parameters:
open - required parameter
See Also:
Feature.setOpen(Boolean)

withAtomAuthor

public ScreenOverlay withAtomAuthor(Author atomAuthor)
Description copied from class: Feature
fluent setter

Overrides:
withAtomAuthor in class Overlay
Parameters:
atomAuthor - required parameter
See Also:
Feature.setAtomAuthor(Author)

withAtomLink

public ScreenOverlay withAtomLink(Link atomLink)
Description copied from class: Feature
fluent setter

Overrides:
withAtomLink in class Overlay
Parameters:
atomLink - required parameter
See Also:
Feature.setAtomLink(Link)

withAddress

public ScreenOverlay withAddress(java.lang.String address)
Description copied from class: Feature
fluent setter

Overrides:
withAddress in class Overlay
Parameters:
address - required parameter
See Also:
Feature.setAddress(String)

withXalAddressDetails

public ScreenOverlay withXalAddressDetails(AddressDetails xalAddressDetails)
Description copied from class: Feature
fluent setter

Overrides:
withXalAddressDetails in class Overlay
Parameters:
xalAddressDetails - required parameter
See Also:
Feature.setXalAddressDetails(AddressDetails)

withPhoneNumber

public ScreenOverlay withPhoneNumber(java.lang.String phoneNumber)
Description copied from class: Feature
fluent setter

Overrides:
withPhoneNumber in class Overlay
Parameters:
phoneNumber - required parameter
See Also:
Feature.setPhoneNumber(String)

withSnippet

public ScreenOverlay withSnippet(Snippet snippet)
Description copied from class: Feature
fluent setter

Overrides:
withSnippet in class Overlay
Parameters:
snippet - required parameter
See Also:
Feature.setSnippet(Snippet)

withSnippetd

public ScreenOverlay withSnippetd(java.lang.String snippetd)
Description copied from class: Feature
fluent setter

Overrides:
withSnippetd in class Overlay
Parameters:
snippetd - required parameter
See Also:
Feature.setSnippetd(String)

withDescription

public ScreenOverlay withDescription(java.lang.String description)
Description copied from class: Feature
fluent setter

Overrides:
withDescription in class Overlay
Parameters:
description - required parameter
See Also:
Feature.setDescription(String)

withAbstractView

public ScreenOverlay withAbstractView(AbstractView abstractView)
Description copied from class: Feature
fluent setter

Overrides:
withAbstractView in class Overlay
Parameters:
abstractView - required parameter
See Also:
Feature.setAbstractView(AbstractView)

withTimePrimitive

public ScreenOverlay withTimePrimitive(TimePrimitive timePrimitive)
Description copied from class: Feature
fluent setter

Overrides:
withTimePrimitive in class Overlay
Parameters:
timePrimitive - required parameter
See Also:
Feature.setTimePrimitive(TimePrimitive)

withStyleUrl

public ScreenOverlay withStyleUrl(java.lang.String styleUrl)
Description copied from class: Feature
fluent setter

Overrides:
withStyleUrl in class Overlay
Parameters:
styleUrl - required parameter
See Also:
Feature.setStyleUrl(String)

withStyleSelector

public ScreenOverlay withStyleSelector(java.util.List<StyleSelector> styleSelector)
Description copied from class: Feature
fluent setter

Overrides:
withStyleSelector in class Overlay
Parameters:
styleSelector - required parameter
See Also:
#setStyleSelector(List)

withRegion

public ScreenOverlay withRegion(Region region)
Description copied from class: Feature
fluent setter

Overrides:
withRegion in class Overlay
Parameters:
region - required parameter
See Also:
Feature.setRegion(Region)

withMetadata

public ScreenOverlay withMetadata(Metadata metadata)
Description copied from class: Feature
fluent setter

Overrides:
withMetadata in class Overlay
Parameters:
metadata - required parameter
See Also:
Feature.setMetadata(Metadata)

withExtendedData

public ScreenOverlay withExtendedData(ExtendedData extendedData)
Description copied from class: Feature
fluent setter

Overrides:
withExtendedData in class Overlay
Parameters:
extendedData - required parameter
See Also:
Feature.setExtendedData(ExtendedData)

withFeatureSimpleExtension

public ScreenOverlay withFeatureSimpleExtension(java.util.List<java.lang.Object> featureSimpleExtension)
Description copied from class: Feature
fluent setter

Overrides:
withFeatureSimpleExtension in class Overlay
Parameters:
featureSimpleExtension - required parameter
See Also:
#setFeatureSimpleExtension(List)

withFeatureObjectExtension

public ScreenOverlay withFeatureObjectExtension(java.util.List<AbstractObject> featureObjectExtension)
Description copied from class: Feature
fluent setter

Overrides:
withFeatureObjectExtension in class Overlay
Parameters:
featureObjectExtension - required parameter
See Also:
#setFeatureObjectExtension(List)

withColor

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

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

withDrawOrder

public ScreenOverlay withDrawOrder(int drawOrder)
Description copied from class: Overlay
fluent setter

Overrides:
withDrawOrder in class Overlay
Parameters:
drawOrder - required parameter
See Also:
Overlay.setDrawOrder(int)

withIcon

public ScreenOverlay withIcon(Icon icon)
Description copied from class: Overlay
fluent setter

Overrides:
withIcon in class Overlay
Parameters:
icon - required parameter
See Also:
Overlay.setIcon(Icon)

withOverlaySimpleExtension

public ScreenOverlay withOverlaySimpleExtension(java.util.List<java.lang.Object> overlaySimpleExtension)
Description copied from class: Overlay
fluent setter

Overrides:
withOverlaySimpleExtension in class Overlay
Parameters:
overlaySimpleExtension - required parameter
See Also:
#setOverlaySimpleExtension(List)

withOverlayObjectExtension

public ScreenOverlay withOverlayObjectExtension(java.util.List<AbstractObject> overlayObjectExtension)
Description copied from class: Overlay
fluent setter

Overrides:
withOverlayObjectExtension in class Overlay
Parameters:
overlayObjectExtension - required parameter
See Also:
#setOverlayObjectExtension(List)

clone

public ScreenOverlay clone()
Overrides:
clone in class Overlay