Class ProgressIndicator
Prev Chapter 17. Package com.itmill.toolkit.ui Next

Class ProgressIndicator

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

Synopsis

Since

3.1

Inheritance Path.  java.lang.Object-> com.itmill.toolkit.ui.AbstractComponent -> com.itmill.toolkit.ui.AbstractField -> com.itmill.toolkit.ui.ProgressIndicator

ProgressIndicator()

Creates an a new ProgressIndicator.

ProgressIndicator(Float)

Creates a new instance of ProgressIndicator with given state.

ProgressIndicator(Property)

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

CONTENT_PREFORMATTED

Content mode, where the label contains preformatted text.

CONTENT_TEXT

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

getContentMode()

Parameters

return

true if in indeterminate mode

Get the mode of ProgressIndicator.

getPollingInterval()

Parameters

return

interval in milliseconds

Get interval that component checks for progress

getPropertyDataSource()

Get viewing data-source property.

getTag()

Parameters

return

Component UIDL tag as string.

Get component UIDL tag.

getType()

Parameters

return

type of the Property

Description copied from interface: getType

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 .

getValue()

Parameters

return

Value of the ProgressIndicator

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

isReadOnly()

Parameters

return

True iff the component is in read only mode

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

paintContent(PaintTarget)

Parameters

event

PaintEvent.

Paint the content of this component.

setIndeterminate(boolean)

Parameters

newValue

true to set to indeterminate mode

Set ProgressIndicator to indeterminate mode

setPollingInterval(int)

Parameters

newValue

interval in milliseconds

Set interval that compnent checks for progress

setPropertyDataSource(Property)

Set the property as data-source for viewing.

setReadOnly(boolean)

Parameters

readOnly

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

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

setValue(Object)

Parameters

newValue

New value of the ProgressIndicator

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

toString()

Parameters

return

String representation of the value stored in the Property

Description copied from interface: toString

Returns the value of the Property in human readable textual format. The return value should be assignable to the setValue method if the Property is not in read-only mode.

Prev Up Next
Class Panel Home Class Select