com.smartgwt.client.widgets.drawing
Class ColorStop

java.lang.Object
  extended by com.smartgwt.client.core.JsObject
      extended by com.smartgwt.client.core.DataClass
          extended by com.smartgwt.client.core.RefDataClass
              extended by com.smartgwt.client.widgets.drawing.ColorStop

public class ColorStop
extends RefDataClass

An object containing properties that is used in Gradient types


Field Summary
 
Fields inherited from class com.smartgwt.client.core.JsObject
jsObj
 
Constructor Summary
ColorStop()
           
ColorStop(JavaScriptObject jsObj)
           
 
Method Summary
static ColorStop[] convertToColorStopArray(JavaScriptObject nativeArray)
           
 String getColor()
          eg #ff0000 or red or rgb(255,0,0)
 float getOffset()
          The relative offset for the color.
 float getOpacity()
          0 is transparent, 1 is fully opaque
static ColorStop getOrCreateRef(JavaScriptObject jsObj)
           
 void setColor(String color)
          eg #ff0000 or red or rgb(255,0,0)
 void setOffset(float offset)
          The relative offset for the color.
 void setOpacity(float opacity)
          0 is transparent, 1 is fully opaque
 
Methods inherited from class com.smartgwt.client.core.RefDataClass
getRef, getRef
 
Methods inherited from class com.smartgwt.client.core.DataClass
doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, getJsObj, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute
 
Methods inherited from class com.smartgwt.client.core.JsObject
isCreated, setJsObj
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ColorStop

public ColorStop()

ColorStop

public ColorStop(JavaScriptObject jsObj)
Method Detail

getOrCreateRef

public static ColorStop getOrCreateRef(JavaScriptObject jsObj)

setColor

public void setColor(String color)
eg #ff0000 or red or rgb(255,0,0)

Parameters:
color - color Default value is null

getColor

public String getColor()
eg #ff0000 or red or rgb(255,0,0)

Returns:
String

setOffset

public void setOffset(float offset)
The relative offset for the color.

Parameters:
offset - offset Default value is 0.0

getOffset

public float getOffset()
The relative offset for the color.

Returns:
float

setOpacity

public void setOpacity(float opacity)
0 is transparent, 1 is fully opaque

Parameters:
opacity - opacity Default value is 1.0

getOpacity

public float getOpacity()
0 is transparent, 1 is fully opaque

Returns:
float

convertToColorStopArray

public static ColorStop[] convertToColorStopArray(JavaScriptObject nativeArray)