Package muntjac :: Package ui :: Module progress_indicator :: Class ProgressIndicator
[hide private]
[frames] | no frames]

Class ProgressIndicator

source code

                            object --+                    
                                     |                    
                   util.IEventListener --+                
                                         |                
             terminal.paintable.IPaintable --+            
                                             |            
                                object --+   |            
                                         |   |            
    terminal.variable_owner.IVariableOwner --+            
                                             |            
                                object --+   |            
                                         |   |            
               terminal.sizeable.ISizeable --+            
                                             |            
                          component.IComponent --+        
                                                 |        
                                    object --+   |        
                                             |   |        
  event.method_event_source.IMethodEventSource --+        
                                                 |        
              abstract_component.AbstractComponent --+    
                                                     |    
                                object --+           |    
                                         |           |    
                   data.buffered.IBuffered --+       |    
                                             |       |    
                                object --+   |       |    
                                         |   |       |    
             data.validatable.IValidatable --+       |    
                                             |       |    
            data.buffered.IBufferedValidatable --+   |    
                                                 |   |    
                                    object --+   |   |    
                                             |   |   |    
            data.property.IValueChangeNotifier --+   |    
                                                 |   |    
                                    object --+   |   |    
                                             |   |   |    
            data.property.IValueChangeListener --+   |    
                                                 |   |    
                                object --+       |   |    
                                         |       |   |    
                     data.property.IViewer --+   |   |    
                                             |   |   |    
                         data.property.IEditor --+   |    
                                                 |   |    
                        object --+               |   |    
                                 |               |   |    
               util.IEventListener --+           |   |    
                                     |           |   |    
         terminal.paintable.IPaintable --+       |   |    
                                         |       |   |    
                            object --+   |       |   |    
                                     |   |       |   |    
terminal.variable_owner.IVariableOwner --+       |   |    
                                         |       |   |    
                            object --+   |       |   |    
                                     |   |       |   |    
           terminal.sizeable.ISizeable --+       |   |    
                                         |       |   |    
                      component.IComponent --+   |   |    
                                             |   |   |    
                          component.IFocusable --+   |    
                                                 |   |    
                                      field.IField --+    
                                                     |    
                                        object --+   |    
                                                 |   |    
                    event.action.IShortcutNotifier --+    
                                                     |    
                                        object --+   |    
                                                 |   |    
       data.property.IReadOnlyStatusChangeNotifier --+    
                                                     |    
                                        object --+   |    
                                                 |   |    
       data.property.IReadOnlyStatusChangeListener --+    
                                                     |    
                          abstract_field.AbstractField --+
                                                         |
                                            object --+   |
                                                     |   |
                    data.property.IValueChangeListener --+
                                                         |
                                            object --+   |
                                                     |   |
                               data.property.IProperty --+
                                                         |
                                            object --+   |
                                                     |   |
                                 data.property.IViewer --+
                                                         |
                                                        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


Authors:
Vaadin Ltd., Richard Lincoln

Version: 1.1.2

Instance Methods [hide private]
 
__init__(self, *args)
Creates an a new ProgressIndicator.
source code
 
setReadOnly(self, readOnly)
Sets the component to read-only.
source code
 
isReadOnly(self)
Is the component read-only ? Readonly is not used in ProgressIndicator - this returns allways false.
source code
 
paintContent(self, target)
Paints the content of this component.
source code
 
getValue(self)
Gets the value of the ProgressIndicator.
source code
 
setValue(self, newValue, repaintIsNotNeeded=None)
Sets the value of the ProgressIndicator.
source code
 
__str__(self)
Returns the value of the IProperty in human readable textual format.
source code
 
getType(self)
Returns the type of the IProperty.
source code
 
getPropertyDataSource(self)
Gets the viewing data-source property.
source code
 
setPropertyDataSource(self, newDataSource)
Sets the property as data-source for viewing.
source code
 
getContentMode(self)
Gets the mode of ProgressIndicator.
source code
 
setIndeterminate(self, newValue)
Sets wheter or not the ProgressIndicator is indeterminate.
source code
 
isIndeterminate(self)
Gets whether or not the ProgressIndicator is indeterminate.
source code
 
setPollingInterval(self, newValue)
Sets the interval that component checks for progress.
source code
 
getPollingInterval(self)
Gets the interval that component checks for progress.
source code

Inherited from abstract_field.AbstractField: addCallback, addListener, addShortcutListener, addValidator, attach, changeVariables, commit, detach, discard, fireReadOnlyStatusChange, fireValueChange, focus, getActionManager, getErrorMessage, getRequiredError, getTabIndex, getValidators, isEmpty, isInvalidAllowed, isInvalidCommitted, isModified, isReadThrough, isRequired, isValid, isValidationVisible, isWriteThrough, readOnlyStatusChange, readValueFromProperty, removeCallback, removeListener, removeShortcutListener, removeValidator, setCurrentBufferedSourceException, setInternalValue, setInvalidAllowed, setInvalidCommitted, setReadThrough, setRequired, setRequiredError, setTabIndex, setValidationVisible, setWriteThrough, shouldHideErrors, validate, valueChange

Inherited from abstract_component.AbstractComponent: __getstate__, __setstate__, addStyleName, childRequestedRepaint, fireComponentErrorEvent, fireComponentEvent, fireEvent, fireRequestRepaintEvent, getApplication, getCSSHeight, getCSSWidth, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorHandler, getHeight, getHeightUnits, getIcon, getListeners, getLocale, getParent, getStyle, getStyleName, getWidth, getWidthUnits, getWindow, handleError, hasListeners, isEnabled, isImmediate, isVisible, paint, parseStringSize, registerCallback, registerListener, removeStyleName, requestRepaint, requestRepaintRequests, setCaption, setComponentError, setData, setDebugId, setDescription, setEnabled, setErrorHandler, setHeight, setHeightUnits, setIcon, setImmediate, setLocale, setParent, setSizeFull, setSizeUndefined, setStyle, setStyleName, setVisible, setWidth, setWidthUnits, withdrawCallback, withdrawListener

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Class Methods [hide private]

Inherited from abstract_field.AbstractField: constructField

Class Variables [hide private]
  CLIENT_WIDGET = None
hash(x)
  CONTENT_TEXT = 0
  CONTENT_PREFORMATTED = 1

Inherited from abstract_component.AbstractComponent: SIZE_PATTERN

Inherited from terminal.sizeable.ISizeable: SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS, UNIT_SYMBOLS

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, *args)
(Constructor)

source code 

Creates an a new ProgressIndicator.

Parameters:
  • args - tuple of the form
    • ()
    • (value)
    • (contentSource)
Overrides: object.__init__

setReadOnly(self, readOnly)

source code 

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

Parameters:
  • readOnly - True to enable read-only mode, False to disable it.
Overrides: component.IComponent.setReadOnly

isReadOnly(self)

source code 

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

Returns:
True if the component is in read only mode.
Overrides: component.IComponent.isReadOnly

paintContent(self, target)

source code 

Paints the content of this component.

Parameters:
  • target - the Paint Event.
Raises:
Overrides: abstract_component.AbstractComponent.paintContent

getValue(self)

source code 

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

Returns:
the Value of the ProgressIndicator.
Overrides: data.property.IProperty.getValue

See Also: AbstractField.getValue

setValue(self, newValue, repaintIsNotNeeded=None)

source code 

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

Parameters:
  • newValue - the new value of the ProgressIndicator.
Raises:
Overrides: data.property.IProperty.setValue

See Also: AbstractField.setValue

__str__(self)
(Informal representation operator)

source code 

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

Returns:
String representation of the value stored in the IProperty
Overrides: object.__str__

See Also: AbstractField.__str__

getType(self)

source code 

Returns the type of the IProperty. 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.

Returns:
type of the IProperty
Overrides: data.property.IProperty.getType

See Also: AbstractField.getType

getPropertyDataSource(self)

source code 

Gets the viewing data-source property.

Returns:
the datasource.
Overrides: data.property.IViewer.getPropertyDataSource

See Also: AbstractField.getPropertyDataSource

setPropertyDataSource(self, newDataSource)

source code 

Sets the property as data-source for viewing.

Parameters:
  • newDataSource - the new data source.
Overrides: data.property.IViewer.setPropertyDataSource

See Also: AbstractField.setPropertyDataSource

getContentMode(self)

source code 

Gets the mode of ProgressIndicator.

Returns:
true if in indeterminate mode.

setIndeterminate(self, newValue)

source code 

Sets wheter or not the ProgressIndicator is indeterminate.

Parameters:
  • newValue - true to set to indeterminate mode.

isIndeterminate(self)

source code 

Gets whether or not the ProgressIndicator is indeterminate.

Returns:
true to set to indeterminate mode.

setPollingInterval(self, newValue)

source code 

Sets the interval that component checks for progress.

Parameters:
  • newValue - the interval in milliseconds.

getPollingInterval(self)

source code 

Gets the interval that component checks for progress.

Returns:
the interval in milliseconds.