Home | Trees | Indices | Help |
|
---|
|
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.
Version: 1.1.2
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Inherited from Inherited from Inherited from |
|
|||
Inherited from |
|
|||
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 Inherited from |
|
|||
Inherited from |
|
Creates an empty Select with caption, that is connected to a data-source or is filled from a collection of option values.
|
Paints the content of this component.
|
Invoked when the value of a variable has changed.
See Also:
|
Getter for new item handler.
|
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. |
Returns the type of the property.
See Also: IContainer.getType |
Gets the selected item id or in multiselect mode a set of selected ids.
See Also: AbstractField.getValue |
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.
See Also: AbstractField.setValue |
Gets the item from the container with given id. If the container does not contain the requested item, null is returned.
|
Gets the item Id collection from the container.
|
Gets the property Id collection from the container.
|
Gets the number of visible Items in the IContainer. Filtering can hide items so that they will not be visible through the container API.
|
Tests, if the collection contains an item with given id.
|
Gets the IProperty identified by the given itemId and propertyId from the IContainer
See Also: IContainer.getContainerProperty |
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.
See Also: IContainer.addContainerProperty |
Removes all items from the container. This functionality is optional. If the function is unsupported, it always returns false.
See Also: IContainer.removeAllItems |
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.
See Also: IContainer.addItem |
Removes the Item identified by Containers that support filtering should also allow removing an item that is currently filtered out. This functionality is optional.
|
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.
See Also: IContainer.removeContainerProperty |
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.
|
Gets the viewing data-source container.
|
Is the select in multiselect mode? In multiselect mode
|
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.
|
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.
|
Enables or disables possibility to add new options by the user.
|
Override the caption of an item. Setting caption explicitly overrides id, item and index captions.
|
Gets the caption of an item. The caption is generated as specified by
the item caption mode. See
|
Sets the icon for an item.
|
Gets the item icon.
|
Sets the item caption mode. The mode can be one of the following ones:
The
|
Gets the item caption mode. The mode can be one of the following ones:
The
|
Sets the item caption property. Setting the id to a existing property implicitly sets the item caption
mode to Setting the property id to null disables this feature. The id is null by default.
|
Gets the item caption property.
|
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 Setting the property id to null disables this feature. The id is null by default.
|
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 Setting the property id to null disables this feature. The id is null by default.
|
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.
|
Selects an item. In single select mode selecting item identified by getNullSelectionItemId sets the value of the property to null.
|
Unselects an item.
|
Notifies this listener that the Containers contents has changed.
|
Adds a new IProperty or IItem set change listener for this IContainer.
|
|
Removes a previously registered IProperty and IItemset change listener.
|
|
Returns all listeners that are registered for the given event type or one of its subclasses.
|
Lets the listener know a Containers IItem set has changed.
|
For multi-selectable fields, also an empty collection of values is considered to be an empty field.
See Also: AbstractField.isEmpty. |
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
|
Checks if null empty selection is allowed by the user.
See Also: setNullSelectionAllowed |
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.
|
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.
|
Notifies the component that it is connected to an application.
See Also:
|
Detaches the component from application.
See Also:
|
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0.1 on Sat Jul 6 13:40:55 2013 | http://epydoc.sourceforge.net |