Package muntjac :: Package ui :: Module field :: Class IField
[hide private]
[frames] | no frames]

Class IField

source code

                                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 --+
                                                 |
                                                IField


Authors:
Vaadin Ltd., Richard Lincoln
Instance Methods [hide private]
 
setCaption(self, caption)
Sets the Caption.
source code
 
getDescription(self) source code
 
setDescription(self, caption)
Sets the Description.
source code
 
isRequired(self)
Is this field required.
source code
 
setRequired(self, required)
Sets the field required.
source code
 
setRequiredError(self, requiredMessage)
Sets the error message to be displayed if a required field is empty.
source code
 
getRequiredError(self)
Gets the error message that is to be displayed if a required field is empty.
source code

Inherited from data.buffered.IBufferedValidatable: isInvalidCommitted, setInvalidCommitted

Inherited from data.buffered.IBuffered: commit, discard, isModified, isReadThrough, isWriteThrough, setReadThrough, setWriteThrough

Inherited from data.validatable.IValidatable: addValidator, getValidators, isInvalidAllowed, isValid, removeValidator, setInvalidAllowed, validate

Inherited from data.property.IValueChangeNotifier: addCallback, addListener, removeCallback, removeListener

Inherited from data.property.IValueChangeListener: valueChange

Inherited from data.property.IViewer: getPropertyDataSource, setPropertyDataSource

Inherited from component.IFocusable: focus, getTabIndex, setTabIndex

Inherited from component.IComponent: addStyleName, attach, childRequestedRepaint, detach, getApplication, getCaption, getIcon, getLocale, getParent, getStyleName, getWindow, isEnabled, isReadOnly, isVisible, removeStyleName, setEnabled, setIcon, setParent, setReadOnly, setStyleName, setVisible

Inherited from terminal.paintable.IPaintable: getDebugId, paint, requestRepaint, requestRepaintRequests, setDebugId

Inherited from terminal.variable_owner.IVariableOwner: changeVariables, isImmediate

Inherited from terminal.sizeable.ISizeable: getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeightUnits, setSizeFull, setSizeUndefined, setWidth, setWidthUnits

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

Class Variables [hide private]

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]

setCaption(self, caption)

source code 

Sets the Caption.

Parameters:
  • caption - the new caption for the component. If the caption is None, no caption is shown and it does not normally take any space
Overrides: component.IComponent.setCaption

isRequired(self)

source code 

Is this field required.

Required fields must filled by the user.

Returns:
True if the field is required, otherwise False.

setRequired(self, required)

source code 

Sets the field required. Required fields must filled by the user.

Parameters:
  • required - Is the field required.

setRequiredError(self, requiredMessage)

source code 

Sets the error message to be displayed if a required field is empty.

Parameters:
  • requiredMessage - Error message.

getRequiredError(self)

source code 

Gets the error message that is to be displayed if a required field is empty.

Returns:
Error message.