com.sun.svg.component
Class SVGProgressBar

java.lang.Object
  extended by com.sun.svg.component.SVGProgressBar

public class SVGProgressBar
extends java.lang.Object

The SVGProgressBar class is a primitive component which can be attached to SVG markup which follows the expected structure for a progress bar. The expected structure for the progress bar is that there is a background element which defines the maximum size for the progress indicator and there is a progress indicator which should be scaled, along the horizontal axis, to reflect the progress value. The code also expects a text indicator to display the value as %. The code assumes that the progressBar background and the progress indicator have the same x=axis origin.


Field Summary
(package private) static java.lang.String BACKGROUND_SUFFIX
           
protected  java.lang.String idPrefix
          The prefix used for all the elements in the scroll bar component.
protected  float maxScale
          The max scale for the progress bar along the y-axis
protected  float minScale
          The min scale of the progress bar along the x-axis
protected  float pos
          The current progress bar position in the [0,1] range.
protected  org.w3c.dom.svg.SVGLocatableElement progress
          The progress bar progress indicator
(package private) static java.lang.String PROGRESS_SUFFIX
           
protected  org.w3c.dom.svg.SVGRect progressBBox
          The progress indicator's bounding box.
protected  org.w3c.dom.svg.SVGMatrix progressTxf
          The progress's initial transform.
protected  org.w3c.dom.svg.SVGSVGElement svg
          The document's root svg element.
protected  org.w3c.dom.svg.SVGElement text
          The progress bar's text display.
(package private) static java.lang.String TEXT_SUFFIX
           
 
Constructor Summary
SVGProgressBar(java.lang.String idPrefix)
           
 
Method Summary
 void hookSkin(org.w3c.dom.Document doc)
          Hooks the input skin to this user interface component.
 void setProgress(float pos)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROGRESS_SUFFIX

static final java.lang.String PROGRESS_SUFFIX
See Also:
Constant Field Values

BACKGROUND_SUFFIX

static final java.lang.String BACKGROUND_SUFFIX
See Also:
Constant Field Values

TEXT_SUFFIX

static final java.lang.String TEXT_SUFFIX
See Also:
Constant Field Values

progress

protected org.w3c.dom.svg.SVGLocatableElement progress
The progress bar progress indicator


progressTxf

protected org.w3c.dom.svg.SVGMatrix progressTxf
The progress's initial transform.


progressBBox

protected org.w3c.dom.svg.SVGRect progressBBox
The progress indicator's bounding box.


minScale

protected float minScale
The min scale of the progress bar along the x-axis


maxScale

protected float maxScale
The max scale for the progress bar along the y-axis


svg

protected org.w3c.dom.svg.SVGSVGElement svg
The document's root svg element.


text

protected org.w3c.dom.svg.SVGElement text
The progress bar's text display.


idPrefix

protected java.lang.String idPrefix
The prefix used for all the elements in the scroll bar component.


pos

protected float pos
The current progress bar position in the [0,1] range.

Constructor Detail

SVGProgressBar

public SVGProgressBar(java.lang.String idPrefix)
Parameters:
idPrefix - - the progress bar group identifier.
Method Detail

hookSkin

public void hookSkin(org.w3c.dom.Document doc)
Hooks the input skin to this user interface component.

Parameters:
doc - - the new Document skin containing the associated progress bar elements.

setProgress

public void setProgress(float pos)
Parameters:
pos - the desired thumb position in the [0, 1] interval. If the value is out of range, it is clipped to the valid range.