com.itmill.toolkit.ui
Class ProgressIndicator

java.lang.Object
  com.itmill.toolkit.terminal.Identifiable
      com.itmill.toolkit.ui.AbstractComponent
          com.itmill.toolkit.ui.AbstractField
              com.itmill.toolkit.ui.ProgressIndicator

All Implemented Interfaces:

Buffered, BufferedValidatable, Property, Property.Editor, Property.ReadOnlyStatusChangeNotifier, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer, Validatable, MethodEventSource, Paintable, VariableOwner, Component, Component.Focusable, Field, EventListener

public class ProgressIndicator
extends AbstractField
implements Property, Property.Viewer, Property.ValueChangeListener

ProgressIndicator is component that shows user state of a process (like long computing or file upload) ProgressIndicator has two mainmodes. One for indeterminate processes and other (default) for processes which progress can be measured May view an other property that indicates progress 0...1

Since:

3.1

Version:

4.1.4

Author:

IT Mill Ltd.

Nested Class Summary

Nested classes/interfaces inherited from class com.itmill.toolkit.ui.AbstractField

AbstractField.ReadOnlyStatusChangeEvent

Nested classes/interfaces inherited from interface com.itmill.toolkit.data.Property

Property.ConversionException, Property.Editor, Property.ReadOnlyException, Property.ReadOnlyStatusChangeEvent, Property.ReadOnlyStatusChangeListener, Property.ReadOnlyStatusChangeNotifier, Property.ValueChangeEvent, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer

Nested classes/interfaces inherited from interface com.itmill.toolkit.ui.Field

Field.ValueChangeEvent

Nested classes/interfaces inherited from interface com.itmill.toolkit.ui.Component

Component.ErrorEvent, Component.ErrorListener, Component.Event, Component.Focusable, Component.Listener

Nested classes/interfaces inherited from interface com.itmill.toolkit.terminal.Paintable

Paintable.RepaintRequestEvent, Paintable.RepaintRequestListener

Nested classes/interfaces inherited from interface com.itmill.toolkit.data.Buffered

Buffered.SourceException

Field Summary

static int	CONTENT_PREFORMATTED Content mode, where the label contains preformatted text.
static int	CONTENT_TEXT Content mode, where the label contains only plain text.

Constructor Summary

ProgressIndicator()
Creates an a new ProgressIndicator.

ProgressIndicator(Float value)
Creates a new instance of ProgressIndicator with given state.

ProgressIndicator(Property contentSource)
Creates a new instance of ProgressIndicator with stae read from given datasource.

Method Summary

boolean	getContentMode() Gets the mode of ProgressIndicator.
int	getPollingInterval() Gets the interval that component checks for progress.
Property	getPropertyDataSource() Gets the viewing data-source property.
String	getTag() Gets the component UIDL tag.
Class	getType() Returns the type of the Property.
Object	getValue() Gets the value of the ProgressIndicator.
boolean	isReadOnly() Is the component read-only ?
void	paintContent(PaintTarget target) Paints the content of this component.
void	setIndeterminate(boolean newValue) Sets the ProgressIndicator to indeterminate mode.
void	setPollingInterval(int newValue) Sets the interval that component checks for progress.
void	setPropertyDataSource(Property newDataSource) Sets the property as data-source for viewing.
void	setReadOnly(boolean readOnly) Sets the component to read-only.
void	setValue(Object newValue) Sets the value of the ProgressIndicator.
String	toString() Returns the value of the Property in human readable textual format.

Methods inherited from class com.itmill.toolkit.ui.AbstractField

addListener, addListener, addValidator, attach, commit, constructField, discard, finalize, fireReadOnlyStatusChange, fireValueChange, focus, getErrorMessage, getFocusableId, getTabIndex, getValidators, isInvalidAllowed, isInvalidCommitted, isModified, isReadThrough, isRequired, isValid, isWriteThrough, removeListener, removeListener, removeValidator, setInternalValue, setInvalidAllowed, setInvalidCommitted, setReadThrough, setRequired, setTabIndex, setWriteThrough, validate, valueChange

Methods inherited from class com.itmill.toolkit.ui.AbstractComponent

addListener, addListener, addListener, addListener, changeVariables, childRequestedRepaint, dependsOn, detach, fireComponentErrorEvent, fireComponentEvent, fireEvent, getApplication, getCaption, getComponentError, getData, getDescription, getDirectDependencies, getIcon, getLocale, getParent, getStyle, getWindow, isEnabled, isImmediate, isVisible, paint, removeDirectDependency, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintRequests, setCaption, setComponentError, setData, setDescription, setEnabled, setIcon, setImmediate, setLocale, setParent, setStyle, setVisible

Methods inherited from class com.itmill.toolkit.terminal.Identifiable

getDebugId, getUIID, setDebugId, setUIID

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.itmill.toolkit.data.Property.ValueChangeListener

valueChange

Methods inherited from interface com.itmill.toolkit.ui.Field

getDescription, setCaption, setDescription

Methods inherited from interface com.itmill.toolkit.ui.Component

addListener, childRequestedRepaint, detach, getApplication, getCaption, getIcon, getLocale, getParent, getStyle, getWindow, isEnabled, isVisible, removeListener, setEnabled, setParent, setStyle, setVisible

Methods inherited from interface com.itmill.toolkit.terminal.Paintable

addListener, paint, removeListener, requestRepaint, requestRepaintRequests

Methods inherited from interface com.itmill.toolkit.terminal.VariableOwner

changeVariables, dependsOn, getDirectDependencies, isImmediate, removeDirectDependency

Field Detail

CONTENT_TEXT

public static final int CONTENT_TEXT

Content mode, where the label contains only plain text. The getValue() result is coded to XML when painting.

See Also:

Constant Field Values

CONTENT_PREFORMATTED

public static final int CONTENT_PREFORMATTED

Content mode, where the label contains preformatted text.

See Also:

Constant Field Values

Constructor Detail

ProgressIndicator

public ProgressIndicator()

Creates an a new ProgressIndicator.

ProgressIndicator

public ProgressIndicator(Float value)

Creates a new instance of ProgressIndicator with given state.

Parameters:

value -

ProgressIndicator

public ProgressIndicator(Property contentSource)

Creates a new instance of ProgressIndicator with stae read from given datasource.

Parameters:

contentSource -

Method Detail

getTag

public String getTag()

Gets the component UIDL tag.

Specified by:

getTag in class AbstractComponent

Returns:

the Component UIDL tag as string.

setReadOnly

public void setReadOnly(boolean readOnly)

Sets the component to read-only. Readonly is not used in ProgressIndicator.

Specified by:

setReadOnly in interface Property

Specified by:

setReadOnly in interface Component

Overrides:

setReadOnly in class AbstractField

Parameters:

readOnly - True to enable read-only mode, False to disable it.

See Also:

Component.setReadOnly(boolean)

isReadOnly

public boolean isReadOnly()

Is the component read-only ? Readonly is not used in ProgressIndicator - this returns allways false.

Specified by:

isReadOnly in interface Property

Specified by:

isReadOnly in interface Component

Overrides:

isReadOnly in class AbstractField

Returns:

True if the component is in read only mode.

paintContent

public void paintContent(PaintTarget target)
                  throws PaintException

Paints the content of this component.

Overrides:

paintContent in class AbstractField

Parameters:

target - the Paint Event.

Throws:

PaintException - if the Paint Operation fails.

getValue

public Object getValue()

Gets the value of the ProgressIndicator. Value of the ProgressIndicator is Float between 0 and 1.

Specified by:

getValue in interface Property

Overrides:

getValue in class AbstractField

Returns:

the Value of the ProgressIndicator.

See Also:

AbstractField.getValue()

setValue

public void setValue(Object newValue)

Sets the value of the ProgressIndicator. Value of the ProgressIndicator is the Float between 0 and 1.

Specified by:

setValue in interface Property

Overrides:

setValue in class AbstractField

Parameters:

newValue - the New value of the ProgressIndicator.

See Also:

AbstractField.setValue(java.lang.Object)

toString

public String toString()

Description copied from class: AbstractField

Returns the value of the Property in human readable textual format.

Specified by:

toString in interface Property

Overrides:

toString in class AbstractField

Returns:

String representation of the value stored in the Property

See Also:

AbstractField.toString()

getType

public Class getType()

Description copied from interface: Property

Returns the type of the Property. The methods getValue and setValue must be compatible with this type: one must be able to safely cast the value returned from getValue to the given type and pass any variable assignable to this type as an argument to setValue.

Specified by:

getType in interface Property

Specified by:

getType in class AbstractField

Returns:

type of the Property

See Also:

AbstractField.getType()

getPropertyDataSource

public Property getPropertyDataSource()

Gets the viewing data-source property.

Specified by:

getPropertyDataSource in interface Property.Viewer

Overrides:

getPropertyDataSource in class AbstractField

Returns:

the datasource.

See Also:

AbstractField.getPropertyDataSource()

setPropertyDataSource

public void setPropertyDataSource(Property newDataSource)

Sets the property as data-source for viewing.

Specified by:

setPropertyDataSource in interface Property.Viewer

Overrides:

setPropertyDataSource in class AbstractField

Parameters:

newDataSource - the new data source.

See Also:

AbstractField.setPropertyDataSource(com.itmill.toolkit.data.Property)

getContentMode

public boolean getContentMode()

Gets the mode of ProgressIndicator.

Returns:

true if in indeterminate mode.

setIndeterminate

public void setIndeterminate(boolean newValue)

Sets the ProgressIndicator to indeterminate mode.

Parameters:

newValue - true to set to indeterminate mode.

setPollingInterval

public void setPollingInterval(int newValue)

Sets the interval that component checks for progress.

Parameters:

newValue - the interval in milliseconds.

getPollingInterval

public int getPollingInterval()

Gets the interval that component checks for progress.

Returns:

the interval in milliseconds.