com.googlecode.lanterna.gui.component

Class ProgressBar

java.lang.Object

com.googlecode.lanterna.gui.component.AbstractComponent

com.googlecode.lanterna.gui.component.ProgressBar

All Implemented Interfaces:

Component

public class ProgressBar
extends AbstractComponent

Author:

Martin

Nested Class Summary

Nested classes/interfaces inherited from interface com.googlecode.lanterna.gui.Component

Component.Alignment

Constructor Summary

Constructors

Constructor and Description
ProgressBar(int preferredWidth)

Method Summary

Methods

Modifier and Type	Method and Description
protected TerminalSize	calculatePreferredSize()
char	getCompleteFillChar()
double	getProgress()
char	getRemainingFillChar()
boolean	isCompletedPercentageShown()
void	repaint(TextGraphics graphics) This is the main 'paint' method for a component, it's called when lanterna wants the component to re-draw itself.
void	setCompletedPercentageShown(boolean flag) Controls whether the completion percentage will be shown to the left of the progress bar.
void	setCompleteFillChar(char fill) Sets the character used to fill the portion of the progress bar indicating the completed portion.
void	setProgress(double progress)
void	setRemainingFillChar(char fill) Sets the character used to fill the portion of the progress bar indicating the incomplete portion.

Methods inherited from class com.googlecode.lanterna.gui.component.AbstractComponent

addBorder, addComponentListener, getAlignment, getComponentListeners, getGUIScreen, getMinimumSize, getParent, getPreferredSize, getWindow, invalidate, isScrollable, isVisible, removeComponentListener, setAlignment, setParent, setPreferredSize, setVisible, transformAccordingToAlignment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProgressBar

public ProgressBar(int preferredWidth)

Method Detail

calculatePreferredSize

protected TerminalSize calculatePreferredSize()

Specified by:

calculatePreferredSize in class AbstractComponent

repaint

public void repaint(TextGraphics graphics)

Description copied from interface: Component

This is the main 'paint' method for a component, it's called when lanterna wants the component to re-draw itself. Use the supplied TextGraphics object to draw the component. In order to find out how the size of your compnent (as decided by the layout), use the graphics objects and query for its size.

Parameters:

graphics - TextGraphics object to use for drawing the component and getting information about the drawing context

getProgress

public double getProgress()

setProgress

public void setProgress(double progress)

setCompleteFillChar

public void setCompleteFillChar(char fill)

Sets the character used to fill the portion of the progress bar indicating the completed portion.

getCompleteFillChar

public char getCompleteFillChar()

setRemainingFillChar

public void setRemainingFillChar(char fill)

Sets the character used to fill the portion of the progress bar indicating the incomplete portion.

getRemainingFillChar

public char getRemainingFillChar()

setCompletedPercentageShown

public void setCompletedPercentageShown(boolean flag)

Controls whether the completion percentage will be shown to the left of the progress bar.

isCompletedPercentageShown

public boolean isCompletedPercentageShown()