maps.gml.editor

Class ProgressFunction

java.lang.Object

maps.gml.editor.AbstractFunction

maps.gml.editor.ProgressFunction

All Implemented Interfaces:

Function

Direct Known Subclasses:

AddNoiseFunction, ComputePassableEdgesFunction, FixAttachedObjectsFunction, FixDegenerateShapesFunction, FixDuplicateEdgesFunction, FixNearbyNodesFunction, SplitEdgesFunction

public abstract class ProgressFunction
extends AbstractFunction

Abstract base class for Function implementations that require a progress dialog.

Field Summary

Fields inherited from class maps.gml.editor.AbstractFunction

editor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProgressFunction(GMLEditor editor) Construct a ProgressFunction.

Method Summary

Modifier and Type	Method and Description
protected void	bumpMaxProgress() Increase the maximum progress level by one.
protected void	bumpMaxProgress(int amount) Increase the maximum progress level by some amount.
protected void	bumpProgress() Increase the progress level by one.
void	execute() Execute this function.
protected abstract void	executeImpl() Execute the function.
protected abstract java.lang.String	getTitle() Get the title for the progress dialog.
protected void	setProgress(int amount) Set the progress level.
protected void	setProgressLimit(int max) Set the progress maximum.
protected void	setProgressString(java.lang.String s) Set the progress string.

Methods inherited from class java.lang.Object

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

Methods inherited from interface maps.gml.editor.Function

getName

Constructor Detail

ProgressFunction

protected ProgressFunction(GMLEditor editor)

Construct a ProgressFunction.

Parameters:

editor - The editor instance.

Method Detail

execute

public void execute()

Description copied from interface: Function

Execute this function.

executeImpl

protected abstract void executeImpl()

Execute the function.

getTitle

protected abstract java.lang.String getTitle()

Get the title for the progress dialog.

Returns:

The dialog title.

setProgress

protected void setProgress(int amount)

Set the progress level.

Parameters:

amount - The new progress.

bumpProgress

protected void bumpProgress()

Increase the progress level by one.

bumpMaxProgress

protected void bumpMaxProgress()

Increase the maximum progress level by one.

bumpMaxProgress

protected void bumpMaxProgress(int amount)

Increase the maximum progress level by some amount.

Parameters:

amount - The amount to increase the maximum progress level.

setProgressLimit

protected void setProgressLimit(int max)

Set the progress maximum.

Parameters:

max - The new progress maximum.

setProgressString

protected void setProgressString(java.lang.String s)

Set the progress string.

Parameters:

s - The new progress string.