|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.vaadin.ui.AbstractComponent
com.vaadin.ui.AbstractField
com.vaadin.ui.ProgressIndicator
public 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
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class com.vaadin.ui.AbstractField |
|---|
AbstractField.FocusShortcut, AbstractField.ReadOnlyStatusChangeEvent |
| Nested classes/interfaces inherited from class com.vaadin.ui.AbstractComponent |
|---|
AbstractComponent.ComponentErrorEvent, AbstractComponent.ComponentErrorHandler |
| Nested classes/interfaces inherited from interface com.vaadin.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.vaadin.ui.Field |
|---|
Field.ValueChangeEvent |
| Nested classes/interfaces inherited from interface com.vaadin.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. |
Class<?> |
getType()
Returns the type of the Property. |
Object |
getValue()
Gets the value of the ProgressIndicator. |
boolean |
isIndeterminate()
Gets whether or not the ProgressIndicator is indeterminate. |
boolean |
isReadOnly()
Is the component read-only ? Readonly is not used in ProgressIndicator - this returns allways false. |
void |
paintContent(PaintTarget target)
Paints the content of this component. |
void |
setIndeterminate(boolean newValue)
Sets wheter or not the ProgressIndicator is indeterminate. |
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 java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface com.vaadin.data.Property.ValueChangeListener |
|---|
valueChange |
| Methods inherited from interface com.vaadin.ui.Field |
|---|
getDescription, setCaption, setDescription |
| Field Detail |
|---|
public static final int CONTENT_TEXT
public static final int CONTENT_PREFORMATTED
| Constructor Detail |
|---|
public ProgressIndicator()
public ProgressIndicator(Float value)
value - public ProgressIndicator(Property contentSource)
contentSource - | Method Detail |
|---|
public void setReadOnly(boolean readOnly)
setReadOnly in interface PropertysetReadOnly in interface ComponentsetReadOnly in class AbstractFieldreadOnly - True to enable read-only mode, False to disable it.Component.setReadOnly(boolean)public boolean isReadOnly()
isReadOnly in interface PropertyisReadOnly in interface ComponentisReadOnly in class AbstractFieldComponent.setReadOnly(boolean)
public void paintContent(PaintTarget target)
throws PaintException
paintContent in class AbstractFieldtarget - the Paint Event.
PaintException - if the Paint Operation fails.public Object getValue()
getValue in interface PropertygetValue in class AbstractFieldAbstractField.getValue()public void setValue(Object newValue)
setValue in interface PropertysetValue in class AbstractFieldnewValue - the New value of the ProgressIndicator.AbstractField.setValue(java.lang.Object)public String toString()
AbstractField
toString in interface PropertytoString in class AbstractFieldString representation of the value stored in the
PropertyAbstractField.toString()public Class<?> getType()
PropertygetValue 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.
getType in interface PropertygetType in class AbstractFieldAbstractField.getType()public Property getPropertyDataSource()
getPropertyDataSource in interface Property.ViewergetPropertyDataSource in class AbstractFieldAbstractField.getPropertyDataSource()public void setPropertyDataSource(Property newDataSource)
setPropertyDataSource in interface Property.ViewersetPropertyDataSource in class AbstractFieldnewDataSource - the new data source.AbstractField.setPropertyDataSource(com.vaadin.data.Property)public boolean getContentMode()
public void setIndeterminate(boolean newValue)
newValue - true to set to indeterminate mode.public boolean isIndeterminate()
public void setPollingInterval(int newValue)
newValue - the interval in milliseconds.public int getPollingInterval()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||