ScaleBar (org.gvsig.publish.lib.impl.mapserver 1.0.2 API)

java.lang.Object
- org.gvsig.publish.mapserver641.ScaleBar

public class ScaleBar
extends java.lang.Object

Java class for ScaleBar complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ScaleBar">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="align" type="{http://www.mapserver.org/mapserver}alignEnum"/>
         <element name="backgroundColor" type="{http://www.mapserver.org/mapserver}rgbColorType" minOccurs="0"/>
         <element name="color" type="{http://www.mapserver.org/mapserver}rgbColorType" minOccurs="0"/>
         <element name="imageColor" type="{http://www.mapserver.org/mapserver}rgbColorType" minOccurs="0"/>
         <element name="intervals" type="{http://www.w3.org/2001/XMLSchema}positiveInteger" minOccurs="0"/>
         <element name="Label" type="{http://www.mapserver.org/mapserver}Label" minOccurs="0"/>
         <element name="outlineColor" type="{http://www.mapserver.org/mapserver}rgbColorType"/>
         <element name="position" type="{http://www.mapserver.org/mapserver}positionEnum" minOccurs="0"/>
         <element name="postLabelCache" type="{http://www.mapserver.org/mapserver}booleanEnum" minOccurs="0"/>
         <element name="size" type="{http://www.mapserver.org/mapserver}sizeType" minOccurs="0"/>
         <element name="style" minOccurs="0">
           <simpleType>
             <restriction base="{http://www.w3.org/2001/XMLSchema}integer">
               <minInclusive value="0"/>
               <maxInclusive value="1"/>
             </restriction>
           </simpleType>
         </element>
         <element name="transparent" type="{http://www.mapserver.org/mapserver}stateEnum" minOccurs="0"/>
         <element name="units" type="{http://www.mapserver.org/mapserver}unitType" minOccurs="0"/>
       </sequence>
       <attribute name="status" type="{http://www.mapserver.org/mapserver}stateEnumUnion" default="OFF" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected AlignEnum`	`align`
`protected RgbColorType`	`backgroundColor`
`protected RgbColorType`	`color`
`protected RgbColorType`	`imageColor`
`protected java.math.BigInteger`	`intervals`
`protected Label`	`label`
`protected RgbColorType`	`outlineColor`
`protected PositionEnum`	`position`
`protected BooleanEnum`	`postLabelCache`
`protected SizeType`	`size`
`protected java.lang.String`	`status`
`protected java.lang.Integer`	`style`
`protected StateEnum`	`transparent`
`protected UnitType`	`units`

Constructor Summary

Constructors
Constructor and Description

ScaleBar()

Constructors
Constructor and Description
`ScaleBar()`

Method Summary

Methods
Modifier and Type	Method and Description
`AlignEnum`	`getAlign()` Gets the value of the align property.
`RgbColorType`	`getBackgroundColor()` Gets the value of the backgroundColor property.
`RgbColorType`	`getColor()` Gets the value of the color property.
`RgbColorType`	`getImageColor()` Gets the value of the imageColor property.
`java.math.BigInteger`	`getIntervals()` Gets the value of the intervals property.
`Label`	`getLabel()` Gets the value of the label property.
`RgbColorType`	`getOutlineColor()` Gets the value of the outlineColor property.
`PositionEnum`	`getPosition()` Gets the value of the position property.
`BooleanEnum`	`getPostLabelCache()` Gets the value of the postLabelCache property.
`SizeType`	`getSize()` Gets the value of the size property.
`java.lang.String`	`getStatus()` Gets the value of the status property.
`java.lang.Integer`	`getStyle()` Gets the value of the style property.
`StateEnum`	`getTransparent()` Gets the value of the transparent property.
`UnitType`	`getUnits()` Gets the value of the units property.
`void`	`setAlign(AlignEnum value)` Sets the value of the align property.
`void`	`setBackgroundColor(RgbColorType value)` Sets the value of the backgroundColor property.
`void`	`setColor(RgbColorType value)` Sets the value of the color property.
`void`	`setImageColor(RgbColorType value)` Sets the value of the imageColor property.
`void`	`setIntervals(java.math.BigInteger value)` Sets the value of the intervals property.
`void`	`setLabel(Label value)` Sets the value of the label property.
`void`	`setOutlineColor(RgbColorType value)` Sets the value of the outlineColor property.
`void`	`setPosition(PositionEnum value)` Sets the value of the position property.
`void`	`setPostLabelCache(BooleanEnum value)` Sets the value of the postLabelCache property.
`void`	`setSize(SizeType value)` Sets the value of the size property.
`void`	`setStatus(java.lang.String value)` Sets the value of the status property.
`void`	`setStyle(java.lang.Integer value)` Sets the value of the style property.
`void`	`setTransparent(StateEnum value)` Sets the value of the transparent property.
`void`	`setUnits(UnitType value)` Sets the value of the units property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - align
```
protected AlignEnum align
```
  - backgroundColor
```
protected RgbColorType backgroundColor
```
  - color
```
protected RgbColorType color
```
  - imageColor
```
protected RgbColorType imageColor
```
  - intervals
```
protected java.math.BigInteger intervals
```
  - label
```
protected Label label
```
  - outlineColor
```
protected RgbColorType outlineColor
```
  - position
```
protected PositionEnum position
```
  - postLabelCache
```
protected BooleanEnum postLabelCache
```
  - size
```
protected SizeType size
```
  - status
```
protected java.lang.String status
```
  - style
```
protected java.lang.Integer style
```
  - transparent
```
protected StateEnum transparent
```
  - units
```
protected UnitType units
```
- Constructor Detail
  - ScaleBar
```
public ScaleBar()
```
- Method Detail
  - getAlign
```
public AlignEnum getAlign()
```
    Gets the value of the align property.
    
    Returns:
    possible object is AlignEnum
  - getBackgroundColor
```
public RgbColorType getBackgroundColor()
```
    Gets the value of the backgroundColor property.
    
    Returns:
    possible object is RgbColorType
  - getColor
```
public RgbColorType getColor()
```
    Gets the value of the color property.
    
    Returns:
    possible object is RgbColorType
  - getImageColor
```
public RgbColorType getImageColor()
```
    Gets the value of the imageColor property.
    
    Returns:
    possible object is RgbColorType
  - getIntervals
```
public java.math.BigInteger getIntervals()
```
    Gets the value of the intervals property.
    
    Returns:
    possible object is BigInteger
  - getLabel
```
public Label getLabel()
```
    Gets the value of the label property.
    
    Returns:
    possible object is Label
  - getOutlineColor
```
public RgbColorType getOutlineColor()
```
    Gets the value of the outlineColor property.
    
    Returns:
    possible object is RgbColorType
  - getPosition
```
public PositionEnum getPosition()
```
    Gets the value of the position property.
    
    Returns:
    possible object is PositionEnum
  - getPostLabelCache
```
public BooleanEnum getPostLabelCache()
```
    Gets the value of the postLabelCache property.
    
    Returns:
    possible object is BooleanEnum
  - getSize
```
public SizeType getSize()
```
    Gets the value of the size property.
    
    Returns:
    possible object is SizeType
  - getStatus
```
public java.lang.String getStatus()
```
    Gets the value of the status property.
    
    Returns:
    possible object is String
  - getStyle
```
public java.lang.Integer getStyle()
```
    Gets the value of the style property.
    
    Returns:
    possible object is Integer
  - getTransparent
```
public StateEnum getTransparent()
```
    Gets the value of the transparent property.
    
    Returns:
    possible object is StateEnum
  - getUnits
```
public UnitType getUnits()
```
    Gets the value of the units property.
    
    Returns:
    possible object is UnitType
  - setAlign
```
public void setAlign(AlignEnum value)
```
    Sets the value of the align property.
    
    Parameters:
    value - allowed object is AlignEnum
  - setBackgroundColor
```
public void setBackgroundColor(RgbColorType value)
```
    Sets the value of the backgroundColor property.
    
    Parameters:
    value - allowed object is RgbColorType
  - setColor
```
public void setColor(RgbColorType value)
```
    Sets the value of the color property.
    
    Parameters:
    value - allowed object is RgbColorType
  - setImageColor
```
public void setImageColor(RgbColorType value)
```
    Sets the value of the imageColor property.
    
    Parameters:
    value - allowed object is RgbColorType
  - setIntervals
```
public void setIntervals(java.math.BigInteger value)
```
    Sets the value of the intervals property.
    
    Parameters:
    value - allowed object is BigInteger
  - setLabel
```
public void setLabel(Label value)
```
    Sets the value of the label property.
    
    Parameters:
    value - allowed object is Label
  - setOutlineColor
```
public void setOutlineColor(RgbColorType value)
```
    Sets the value of the outlineColor property.
    
    Parameters:
    value - allowed object is RgbColorType
  - setPosition
```
public void setPosition(PositionEnum value)
```
    Sets the value of the position property.
    
    Parameters:
    value - allowed object is PositionEnum
  - setPostLabelCache
```
public void setPostLabelCache(BooleanEnum value)
```
    Sets the value of the postLabelCache property.
    
    Parameters:
    value - allowed object is BooleanEnum
  - setSize
```
public void setSize(SizeType value)
```
    Sets the value of the size property.
    
    Parameters:
    value - allowed object is SizeType
  - setStatus
```
public void setStatus(java.lang.String value)
```
    Sets the value of the status property.
    
    Parameters:
    value - allowed object is String
  - setStyle
```
public void setStyle(java.lang.Integer value)
```
    Sets the value of the style property.
    
    Parameters:
    value - allowed object is Integer
  - setTransparent
```
public void setTransparent(StateEnum value)
```
    Sets the value of the transparent property.
    
    Parameters:
    value - allowed object is StateEnum
  - setUnits
```
public void setUnits(UnitType value)
```
    Sets the value of the units property.
    
    Parameters:
    value - allowed object is UnitType

Class ScaleBar

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

align

backgroundColor

color

imageColor

intervals

label

outlineColor

position

postLabelCache

size

status

style

transparent

units

Constructor Detail

ScaleBar

Method Detail

getAlign

getBackgroundColor

getColor

getImageColor

getIntervals

getLabel

getOutlineColor

getPosition

getPostLabelCache

getSize

getStatus

getStyle

getTransparent

getUnits

setAlign

setBackgroundColor

setColor

setImageColor

setIntervals

setLabel

setOutlineColor

setPosition

setPostLabelCache

setSize

setStatus

setStyle

setTransparent

setUnits