net.charlesames.utility.html
Class ProgressBarBuilder

java.lang.Object
  extended by net.charlesames.utility.html.HtmlBuilder
      extended by net.charlesames.utility.html.ProgressBarBuilder

public class ProgressBarBuilder
extends HtmlBuilder

Generates a progress bar using HTML formatting tags.

Author:
Charles Ames

Nested Class Summary
 
Nested classes/interfaces inherited from class net.charlesames.utility.html.HtmlBuilder
HtmlBuilder.Tags
 
Field Summary
 
Fields inherited from class net.charlesames.utility.html.HtmlBuilder
FILE_EXTENSION
 
Constructor Summary
ProgressBarBuilder()
          Constructor for ProgressBarBuilder instances.
 
Method Summary
 java.lang.String build()
           
 HtmlColor getCompletedColor()
           
 int getHeight()
           
 HtmlColor getPendingColor()
           
 double getProgress()
           
 int getWidth()
           
 void setCompletedColor(HtmlColor completedColor)
           
 void setHeight(int height)
           
 void setPendingColor(HtmlColor pendingColor)
           
 void setProgress(double progress)
           
 void setWidth(int width)
           
 
Methods inherited from class net.charlesames.utility.html.HtmlBuilder
addTableCell, append, appendLineBreak, beginBlockQuote, beginBody, beginCenter, beginDiv, beginHead, beginHtml, beginListItem, beginOrderedList, beginParagraph, beginSpan, beginStyle, beginStyleRule, beginTable, beginTableBody, beginTableCell, beginTableHeader, beginTableHeaderCell, beginTableRow, beginTag, beginUnorderedList, buildAttribute, buildColorDeclaration, buildLink, buildStyleDeclaration, endBlockQuote, endBody, endCenter, endDiv, endHead, endHtml, endListItem, endOrderedList, endParagraph, endSpan, endStyle, endStyleRule, endTable, endTableBody, endTableCell, endTableHeader, endTableHeaderCell, endTableRow, endTag, endUnorderedList, newline, popTag, pushTag, reset, save, tab, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ProgressBarBuilder

public ProgressBarBuilder()
Constructor for ProgressBarBuilder instances.

Method Detail

getCompletedColor

public HtmlColor getCompletedColor()
Returns:
The color used to represent completed activity.

setCompletedColor

public void setCompletedColor(HtmlColor completedColor)
Parameters:
completedColor - The color used to represent completed activity.

getPendingColor

public HtmlColor getPendingColor()
Returns:
The color used to represent pending activity.

setPendingColor

public void setPendingColor(HtmlColor pendingColor)
Parameters:
pendingColor - The color used to represent pending activity.

getWidth

public int getWidth()
Returns:
The width of the progress bar.

setWidth

public void setWidth(int width)
Parameters:
width - The width of the progress bar.

getHeight

public int getHeight()
Returns:
The height of the progress bar.

setHeight

public void setHeight(int height)
Parameters:
height - The height of the progress bar.

getProgress

public double getProgress()
Returns:
Amount completed in range from zero to unity.

setProgress

public void setProgress(double progress)
Parameters:
progress - Amount completed in range from zero to unity.

build

public java.lang.String build()
Returns:
An HTML representation of a progress bar.