Package muntjac :: Package ui :: Module abstract_select :: Class AbstractSelect
[hide private]
[frames] | no frames]

Class AbstractSelect

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.container.IContainer --+
                                                         |
                                            object --+   |
                                                     |   |
                                data.container.IViewer --+
                                                         |
                                            object --+   |
                                                     |   |
             data.container.IPropertySetChangeListener --+
                                                         |
                                            object --+   |
                                                     |   |
             data.container.IPropertySetChangeNotifier --+
                                                         |
                                            object --+   |
                                                     |   |
                 data.container.IItemSetChangeNotifier --+
                                                         |
                                            object --+   |
                                                     |   |
                 data.container.IItemSetChangeListener --+
                                                         |
                                                        AbstractSelect

A class representing a selection of items the user has selected in a UI. The set of choices is presented as a set of IItems in a IContainer.

A Select component may be in single- or multiselect mode. Multiselect mode means that more than one item can be selected simultaneously.


Authors:
Vaadin Ltd., Richard Lincoln

Version: 1.1.2

Instance Methods [hide private]
 
__init__(self, *args)
Creates an empty Select with caption, that is connected to a data-source or is filled from a collection of option values.
source code
 
paintContent(self, target)
Paints the content of this component.
source code
 
paintItem(self, target, itemId) source code
 
changeVariables(self, source, variables)
Invoked when the value of a variable has changed.
source code
 
setNewItemHandler(self, newItemHandler)
Setter for new item handler that is called when user adds new item in newItemAllowed mode.
source code
 
getNewItemHandler(self)
Getter for new item handler.
source code
 
getVisibleItemIds(self)
Gets the visible item ids.
source code
 
getType(self, propertyId=None)
Returns the type of the property.
source code
 
getValue(self)
Gets the selected item id or in multiselect mode a set of selected ids.
source code
 
setValue(self, newValue, repaintIsNotNeeded=None)
Sets the visible value of the property.
source code
 
getItem(self, itemId)
Gets the item from the container with given id.
source code
 
getItemIds(self)
Gets the item Id collection from the container.
source code
 
getContainerPropertyIds(self)
Gets the property Id collection from the container.
source code
 
size(self)
Gets the number of visible Items in the IContainer.
source code
 
__len__(self) source code
 
containsId(self, itemId)
Tests, if the collection contains an item with given id.
source code
 
getContainerProperty(self, itemId, propertyId)
Gets the IProperty identified by the given itemId and propertyId from the IContainer
source code
 
addContainerProperty(self, propertyId, typ, defaultValue)
Adds the new property to all items.
source code
 
removeAllItems(self)
Removes all items from the container.
source code
 
addItem(self, itemId=None)
Create a new item into container.
source code
 
removeItem(self, itemId)
Removes the Item identified by ItemId from the IContainer.
source code
 
removeContainerProperty(self, propertyId)
Removes the property from all items.
source code
 
setContainerDataSource(self, newDataSource)
Sets the IContainer that serves as the data source of the viewer.
source code
 
getContainerDataSource(self)
Gets the viewing data-source container.
source code
 
isMultiSelect(self)
Is the select in multiselect mode? In multiselect mode
source code
 
setMultiSelect(self, multiSelect)
Sets the multiselect mode.
source code
 
isNewItemsAllowed(self)
Does the select allow adding new options by the user.
source code
 
setNewItemsAllowed(self, allowNewOptions)
Enables or disables possibility to add new options by the user.
source code
 
setItemCaption(self, itemId, caption)
Override the caption of an item.
source code
 
getItemCaption(self, itemId)
Gets the caption of an item.
source code
 
setItemIcon(self, itemId, icon)
Sets the icon for an item.
source code
 
getItemIcon(self, itemId)
Gets the item icon.
source code
 
setItemCaptionMode(self, mode)
Sets the item caption mode.
source code
 
getItemCaptionMode(self)
Gets the item caption mode.
source code
 
setItemCaptionPropertyId(self, propertyId)
Sets the item caption property.
source code
 
getItemCaptionPropertyId(self)
Gets the item caption property.
source code
 
setItemIconPropertyId(self, propertyId)
Sets the item icon property.
source code
 
getItemIconPropertyId(self)
Gets the item icon property.
source code
 
isSelected(self, itemId)
Tests if an item is selected.
source code
 
select(self, itemId)
Selects an item.
source code
 
unselect(self, itemId)
Unselects an item.
source code
 
containerPropertySetChange(self, event)
Notifies this listener that the Containers contents has changed.
source code
 
addListener(self, listener, iface=None)
Adds a new IProperty or IItem set change listener for this IContainer.
source code
 
addCallback(self, callback, eventType=None, *args) source code
 
removeListener(self, listener, iface=None)
Removes a previously registered IProperty and IItemset change listener.
source code
 
removeCallback(self, callback, eventType=None) source code
 
getListeners(self, eventType)
Returns all listeners that are registered for the given event type or one of its subclasses.
source code
 
containerItemSetChange(self, event)
Lets the listener know a Containers IItem set has changed.
source code
 
firePropertySetChange(self)
Fires the property set change event.
source code
 
fireItemSetChange(self)
Fires the item set change event.
source code
 
isEmpty(self)
For multi-selectable fields, also an empty collection of values is considered to be an empty field.
source code
 
setNullSelectionAllowed(self, nullSelectionAllowed)
Allow or disallow empty selection by the user.
source code
 
isNullSelectionAllowed(self)
Checks if null empty selection is allowed by the user.
source code
 
getNullSelectionItemId(self)
Returns the item id that represents null value of this select in single select mode.
source code
 
setNullSelectionItemId(self, nullSelectionItemId)
Sets the item id that represents null value of this select.
source code
 
attach(self)
Notifies the component that it is connected to an application.
source code
 
detach(self)
Detaches the component from application.
source code
 
getCaptionChangeListener(self) source code

Inherited from abstract_field.AbstractField: __str__, addShortcutListener, addValidator, commit, discard, fireReadOnlyStatusChange, fireValueChange, focus, getActionManager, getErrorMessage, getPropertyDataSource, getRequiredError, getTabIndex, getValidators, isInvalidAllowed, isInvalidCommitted, isModified, isReadOnly, isReadThrough, isRequired, isValid, isValidationVisible, isWriteThrough, readOnlyStatusChange, readValueFromProperty, removeShortcutListener, removeValidator, setCurrentBufferedSourceException, setInternalValue, setInvalidAllowed, setInvalidCommitted, setPropertyDataSource, setReadOnly, 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, 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]
  ITEM_CAPTION_MODE_ID = 0
  ITEM_CAPTION_MODE_ITEM = 1
  ITEM_CAPTION_MODE_INDEX = 2
  ITEM_CAPTION_MODE_EXPLICIT_DEFAULTS_ID = 3
  ITEM_CAPTION_MODE_EXPLICIT = 4
  ITEM_CAPTION_MODE_ICON_ONLY = 5
  ITEM_CAPTION_MODE_PROPERTY = 6

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 empty Select with caption, that is connected to a data-source or is filled from a collection of option values.

Parameters:
  • args - tuple of the form
    • ()
    • (caption)
      1. the caption of the component.
    • (caption, dataSource)
      1. the caption of the component.
      2. the IContainer datasource to be selected from by this select.
    • (caption, options)
      1. the caption of the component.
      2. the Collection containing the options.
Overrides: object.__init__

paintContent(self, target)

source code 

Paints the content of this component.

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

changeVariables(self, source, variables)

source code 

Invoked when the value of a variable has changed.

Parameters:
  • source - the Source of the variable change. This is the origin of the event. For example in Web Adapter this is the request.
  • variables - the Mapping from variable names to new variable values.
Overrides: terminal.variable_owner.IVariableOwner.changeVariables

See Also: AbstractComponent.changeVariables

getNewItemHandler(self)

source code 

Getter for new item handler.

Returns:
newItemHandler

getVisibleItemIds(self)

source code 

Gets the visible item ids. In Select, this returns list of all item ids, but can be overriden in subclasses if they paint only part of the items to the terminal or null if no items is visible.

getType(self, propertyId=None)

source code 

Returns the type of the property. getValue and setValue methods must be compatible with this type: one can safely cast getValue to given type and pass any variable assignable to this type as a parameter to setValue.

Parameters:
  • propertyId - the Id identifying the property.
Returns:
the Type of the property.
Overrides: data.container.IContainer.getType

See Also: IContainer.getType

getValue(self)

source code 

Gets the selected item id or in multiselect mode a set of selected ids.

Returns:
the current value of the field.
Overrides: abstract_field.AbstractField.getValue

setValue(self, newValue, repaintIsNotNeeded=None)

source code 

Sets the visible value of the property.

The value of the select is the selected item id. If the select is in multiselect-mode, the value is a set of selected item keys. In multiselect mode all collections of id:s can be assigned.

Parameters:
  • newValue - the New selected item or collection of selected items.
  • repaintIsNotNeeded - True if caller is sure that repaint is not needed.
Raises:
Overrides: abstract_field.AbstractField.setValue

getItem(self, itemId)

source code 

Gets the item from the container with given id. If the container does not contain the requested item, null is returned.

Parameters:
  • itemId - the item id.
Returns:
the item from the container.
Overrides: data.container.IContainer.getItem

getItemIds(self)

source code 

Gets the item Id collection from the container.

Returns:
the Collection of item ids.
Overrides: data.container.IContainer.getItemIds

getContainerPropertyIds(self)

source code 

Gets the property Id collection from the container.

Returns:
the Collection of property ids.
Overrides: data.container.IContainer.getContainerPropertyIds

size(self)

source code 

Gets the number of visible Items in the IContainer.

Filtering can hide items so that they will not be visible through the container API.

Returns:
number of Items in the IContainer
Overrides: data.container.IContainer.size
(inherited documentation)

containsId(self, itemId)

source code 

Tests, if the collection contains an item with given id.

Parameters:
  • itemId - the Id the of item to be tested.
Returns:
boolean indicating if the IContainer holds the specified Item
Overrides: data.container.IContainer.containsId

getContainerProperty(self, itemId, propertyId)

source code 

Gets the IProperty identified by the given itemId and propertyId from the IContainer

Parameters:
  • itemId - ID of the visible Item which contains the Property
  • propertyId - ID of the Property to retrieve
Returns:
Property with the given ID or None
Overrides: data.container.IContainer.getContainerProperty

addContainerProperty(self, propertyId, typ, defaultValue)

source code 

Adds the new property to all items. Adds a property with given id, type and default value to all items in the container.

This functionality is optional. If the function is unsupported, it always returns false.

Parameters:
  • propertyId - ID of the Property
  • typ - Data type of the new Property
  • defaultValue - The value all created Properties are initialized to
Returns:
True if the operation succeeded.
Raises:
  • NotImplementedError - if the container does not support explicitly adding container properties
Overrides: data.container.IContainer.addContainerProperty

removeAllItems(self)

source code 

Removes all items from the container.

This functionality is optional. If the function is unsupported, it always returns false.

Returns:
True if the operation succeeded.
Raises:
  • NotImplementedError - if the container does not support removing all items
Overrides: data.container.IContainer.removeAllItems

addItem(self, itemId=None)

source code 

Create a new item into container. The created new item is returned and ready for setting property values. if the creation fails, null is returned. In case the container already contains the item, null is returned.

This functionality is optional. If the function is unsupported, it always returns null.

Parameters:
  • itemId - the Identification of the item to be created.
Returns:
the Created item with the given id, or null in case of failure.
Raises:
  • NotImplementedError - if adding an item with an explicit item ID is not supported by the container
Overrides: data.container.IContainer.addItem

See Also: IContainer.addItem

removeItem(self, itemId)

source code 

Removes the Item identified by ItemId from the IContainer.

Containers that support filtering should also allow removing an item that is currently filtered out.

This functionality is optional.

Parameters:
  • itemId - ID of the Item to remove
Returns:
True if the operation succeeded, False if not
Raises:
  • NotImplementedError - if the container does not support removing individual items
Overrides: data.container.IContainer.removeItem
(inherited documentation)

removeContainerProperty(self, propertyId)

source code 

Removes the property from all items. Removes a property with given id from all the items in the container.

This functionality is optional. If the function is unsupported, it always returns false.

Parameters:
  • propertyId - ID of the Property to remove
Returns:
True if the operation succeeded.
Raises:
  • NotImplementedError - if the container does not support removing container properties
Overrides: data.container.IContainer.removeContainerProperty

setContainerDataSource(self, newDataSource)

source code 

Sets the IContainer that serves as the data source of the viewer.

As a side-effect the fields value (selection) is set to null due old selection not necessary exists in new IContainer.

Parameters:
  • newDataSource - the new data source.
Overrides: data.container.IViewer.setContainerDataSource

getContainerDataSource(self)

source code 

Gets the viewing data-source container.

Returns:
data source IContainer
Overrides: data.container.IViewer.getContainerDataSource

isMultiSelect(self)

source code 

Is the select in multiselect mode? In multiselect mode

Returns:
the Value of property multiSelect.

setMultiSelect(self, multiSelect)

source code 

Sets the multiselect mode. Setting multiselect mode false may loose selection information: if selected items set contains one or more selected items, only one of the selected items is kept as selected.

Parameters:
  • multiSelect - the New value of property multiSelect.

isNewItemsAllowed(self)

source code 

Does the select allow adding new options by the user. If true, the new options can be added to the IContainer. The text entered by the user is used as id. Note that data-source must allow adding new items.

Returns:
True if additions are allowed.

setNewItemsAllowed(self, allowNewOptions)

source code 

Enables or disables possibility to add new options by the user.

Parameters:
  • allowNewOptions - the New value of property allowNewOptions.

setItemCaption(self, itemId, caption)

source code 

Override the caption of an item. Setting caption explicitly overrides id, item and index captions.

Parameters:
  • itemId - the id of the item to be re-captioned.
  • caption - the New caption.

getItemCaption(self, itemId)

source code 

Gets the caption of an item. The caption is generated as specified by the item caption mode. See setItemCaptionMode() for more details.

Parameters:
  • itemId - the id of the item to be queried.
Returns:
the caption for specified item.

setItemIcon(self, itemId, icon)

source code 

Sets the icon for an item.

Parameters:
  • itemId - the id of the item to be assigned an icon.
  • icon - the icon to use or null.

getItemIcon(self, itemId)

source code 

Gets the item icon.

Parameters:
  • itemId - the id of the item to be assigned an icon.
Returns:
the icon for the item or null, if not specified.

setItemCaptionMode(self, mode)

source code 

Sets the item caption mode.

The mode can be one of the following ones:

  • ITEM_CAPTION_MODE_EXPLICIT_DEFAULTS_ID : Items Id-objects toString is used as item caption. If caption is explicitly specified, it overrides the id-caption.
  • ITEM_CAPTION_MODE_ID : Items Id-objects toString is used as item caption.
  • ITEM_CAPTION_MODE_ITEM : IItem-objects toString is used as item caption.
  • ITEM_CAPTION_MODE_INDEX : The index of the item is used as item caption. The index mode can only be used with the containers implementing IContainer.IIndexed interface.
  • ITEM_CAPTION_MODE_EXPLICIT : The item captions must be explicitly specified.
  • ITEM_CAPTION_MODE_PROPERTY : The item captions are read from property, that must be specified with setItemCaptionPropertyId.

The ITEM_CAPTION_MODE_EXPLICIT_DEFAULTS_ID is the default mode.

Parameters:
  • mode - the One of the modes listed above.

getItemCaptionMode(self)

source code 

Gets the item caption mode.

The mode can be one of the following ones:

  • ITEM_CAPTION_MODE_EXPLICIT_DEFAULTS_ID : Items Id-objects toString is used as item caption. If caption is explicitly specified, it overrides the id-caption.
  • ITEM_CAPTION_MODE_ID : Items Id-objects toString is used as item caption.
  • ITEM_CAPTION_MODE_ITEM : IItem-objects toString is used as item caption.
  • ITEM_CAPTION_MODE_INDEX : The index of the item is used as item caption. The index mode can only be used with the containers implementing IContainer.IIndexed interface.
  • ITEM_CAPTION_MODE_EXPLICIT : The item captions must be explicitly specified.
  • ITEM_CAPTION_MODE_PROPERTY : The item captions are read from property, that must be specified with setItemCaptionPropertyId.

The ITEM_CAPTION_MODE_EXPLICIT_DEFAULTS_ID is the default mode.

Returns:
the One of the modes listed above.

setItemCaptionPropertyId(self, propertyId)

source code 

Sets the item caption property.

Setting the id to a existing property implicitly sets the item caption mode to ITEM_CAPTION_MODE_PROPERTY. If the object is in ITEM_CAPTION_MODE_PROPERTY mode, setting caption property id null resets the item caption mode to ITEM_CAPTION_EXPLICIT_DEFAULTS_ID.

Setting the property id to null disables this feature. The id is null by default.

Parameters:
  • propertyId - the id of the property.

getItemCaptionPropertyId(self)

source code 

Gets the item caption property.

Returns:
the Id of the property used as item caption source.

setItemIconPropertyId(self, propertyId)

source code 

Sets the item icon property.

If the property id is set to a valid value, each item is given an icon got from the given property of the items. The type of the property must be assignable to IResource.

Note: The icons set with setItemIcon function override the icons from the property.

Setting the property id to null disables this feature. The id is null by default.

Parameters:
  • propertyId - the id of the property that specifies icons for items or null
Raises:
  • ValueError - If the propertyId is not in the container or is not of a valid type

getItemIconPropertyId(self)

source code 

Gets the item icon property.

If the property id is set to a valid value, each item is given an icon got from the given property of the items. The type of the property must be assignable to Icon.

Note: The icons set with setItemIcon function override the icons from the property.

Setting the property id to null disables this feature. The id is null by default.

Returns:
the Id of the property containing the item icons.

isSelected(self, itemId)

source code 

Tests if an item is selected.

In single select mode testing selection status of the item identified by getNullSelectionItemId returns true if the value of the property is null.

Parameters:
  • itemId - the Id the of the item to be tested.

select(self, itemId)

source code 

Selects an item.

In single select mode selecting item identified by getNullSelectionItemId sets the value of the property to null.

Parameters:
  • itemId - the identifier of IItem to be selected.

unselect(self, itemId)

source code 

Unselects an item.

Parameters:
  • itemId - the identifier of the IItem to be unselected.

containerPropertySetChange(self, event)

source code 

Notifies this listener that the Containers contents has changed.

Parameters:
  • event - Change event.
Overrides: data.container.IPropertySetChangeListener.containerPropertySetChange

addListener(self, listener, iface=None)

source code 

Adds a new IProperty or IItem set change listener for this IContainer.

Parameters:
  • listener - the new IListener to be registered.
Raises:
  • ValueError - unless method has a match in object
Overrides: data.container.IItemSetChangeNotifier.addListener

addCallback(self, callback, eventType=None, *args)

source code 
Overrides: data.container.IItemSetChangeNotifier.addCallback

removeListener(self, listener, iface=None)

source code 

Removes a previously registered IProperty and IItemset change listener.

Parameters:
  • listener - the listener to be removed.
Overrides: data.container.IItemSetChangeNotifier.removeListener

removeCallback(self, callback, eventType=None)

source code 
Overrides: data.container.IItemSetChangeNotifier.removeCallback

getListeners(self, eventType)

source code 

Returns all listeners that are registered for the given event type or one of its subclasses.

Parameters:
  • eventType - The type of event to return listeners for.
Returns:
A collection with all registered listeners. Empty if no listeners are found.
Overrides: abstract_component.AbstractComponent.getListeners
(inherited documentation)

containerItemSetChange(self, event)

source code 

Lets the listener know a Containers IItem set has changed.

Parameters:
  • event - change event text
Overrides: data.container.IItemSetChangeListener.containerItemSetChange

isEmpty(self)

source code 

For multi-selectable fields, also an empty collection of values is considered to be an empty field.

Overrides: abstract_field.AbstractField.isEmpty

setNullSelectionAllowed(self, nullSelectionAllowed)

source code 

Allow or disallow empty selection by the user. If the select is in single-select mode, you can make an item represent the empty selection by calling setNullSelectionItemId(). This way you can for instance set an icon and caption for the null selection item.

Parameters:
  • nullSelectionAllowed - whether or not to allow empty selection

isNullSelectionAllowed(self)

source code 

Checks if null empty selection is allowed by the user.

Returns:
whether or not empty selection is allowed

getNullSelectionItemId(self)

source code 

Returns the item id that represents null value of this select in single select mode.

Data interface does not support nulls as item ids. Selecting the item identified by this id is the same as selecting no items at all. This setting only affects the single select mode.

Returns:
the Object Null value item id.

setNullSelectionItemId(self, nullSelectionItemId)

source code 

Sets the item id that represents null value of this select.

Data interface does not support nulls as item ids. Selecting the item identified by this id is the same as selecting no items at all. This setting only affects the single select mode.

Parameters:
  • nullSelectionItemId - the nullSelectionItemId to set.

attach(self)

source code 

Notifies the component that it is connected to an application.

Overrides: component.IComponent.attach

See Also: AbstractField.attach

detach(self)

source code 

Detaches the component from application.

Overrides: component.IComponent.detach

See Also: AbstractComponent.detach