ListBox

Описание

Компонент ListBox представляет собой список.

Комментарии

Компонент реализован классом ListBox.

Пример

Компонент имеет следующий вид:

Элементами списка являются экземпляры компонентов ListItem и IconListItem. Список может содержать пиктограммы, как показано на рисунке выше. Пиктограммы содержатся в файле, адрес которого установлен в параметрах невизуального компонента ImageList.

Пример создания компонента ListBox.

Список может быть расположен вертикально и горизонтально. Горизонтальный список выглядит следующим образом:

Элементами данного горизонтального списка являются пиктограммы, реализованные классом IconListItem.

Пример создания горизонтального списка.

Элементы из одного списка можно переносить в другой список при помощи механизма Drag&Drop.

Пример создания компонента ListBox с механизмом Drag&Drop.

Конструктор

  Имя конструктора Краткое описание
ListBox Конструктор ListBox создает экземпляр компонента ListBox.

Свойства

  Имя свойства Краткое описание
EmptySelection Свойство EmptySelection определяет возможность выбора пустого множества элементов.
EnableEdit Свойство EnableEdit определяет возможность редактирования элементов списка.
EnableKeyboard Свойство EnableKeyboard определяет возможность выделять элементы списка при помощи клавиш UP, DOWN.
ImageList Свойство ImageList определяет набор пиктограмм для компонента ListBox.
IsScrollToSelected Свойство IsScrollToSelected определяет признак прокручивания списка до выделенного элемента.
Items Свойство Items содержит массив элементов списка.
MultiSelect Свойство MultiSelect определяет, доступен ли множественный выбор элементов списка.
Orientation Свойство Orientation определяет ориентацию компонента ListBox.
SelectedIndex Свойство SelectedIndex определяет индекс выделенной строки списка.
SelectedItem Свойство SelectedItem определяет выделенный элемент списка.
SelectOnMouseDown Свойство SelectOnMouseDown определяет признак выделения элементов при нажатии на них.

Методы

  Имя метода Краткое описание
addItem Метод addItem добавляет новый элемент в список.
beginUpdate Метод beginUpdate устанавливает признак того, что список обновляется.
clear Метод clear удаляет все элементы из списка.
clearSelection Метод clearSelection предназначен для сброса выделения.
endUpdate Метод endUpdate убирает признак того, что список обновляется.
filterByText Метод filterByText осуществляет фильтрацию элементов списка по строке.
getActiveItem Метод getActiveItem возвращает выделенный элемент списка.
getItemByPoint Метод getItemByPoint возвращает элемент списка по заданным координатам.
getLastItemClick Метод getLastItemClick возвращает последний выделенный элемент списка.
getLayoutItems Метод getLayoutItems возвращает массив элементов списка.
getScrollBox Метод getScrollBox возвращает область прокрутки списка элементов.
getSelectedItems Метод getSelectedItems возвращает массив выделенных элементов списка.
insertItem Метод insertItem добавляет элемент в позицию списка элементов, заданную параметром index.
removeItem Метод removeItem удаляет элемент списка по указанному индексу.
scrollToItem Метод scrollToItem прокручивает список до элемента item.
scrollToSelected Метод scrollToSelected прокручивает список до выделенного элемента списка.
selectItemById Метод selectItemById выделяет элемент с указанным идентификатором Id.
setSelectedFocus Метод setSelectedFocus устанавливает фокус по индексу элемента.

События

  Имя события Краткое описание
ItemClick Событие ItemClick наступает при нажатии на элемент списка.
ItemDeselected Событие ItemDeselected наступает при снятии отметки с элемента списка.
ItemEdited Событие ItemEdited наступает после завершения редактирования элемента списка.
ItemEditing Событие ItemEditing наступает при начале редактирования элемента списка.
ItemMouseDown Событие ItemMouseDown наступает при зажатии кнопки мыши на элементе.
ItemSelected Событие ItemSelected наступает при выделении элемента списка.
SelectableSelected Событие SelectableSelected наступает при любом нажатии на элемент списка.

Свойства, унаследованные от класса Control

  Имя свойства Краткое описание
Anchors Свойство Anchors определяет позицию компонента, размещенного внутри контейнера.
Animation Свойство Animation определяет параметры анимации для компонента.
Bottom Свойство Bottom определяет отступ снизу при размещении компонента внутри LayoutPanel.
Content Свойство Content определяет содержимое компонента.
ContextMenu Свойство ContextMenu определяет контекстное меню для компонента.
Data Свойство Data предназначено для хранения любых пользовательских данных.
Enabled Свойство Enabled определяет признак доступности компонента для использования.
Height Свойство Height определяет высоту компонента.
IsRTL Свойство IsRTL определяет признак расположения элементов компонента по правому краю.
IsVisible Свойство IsVisible определяет признак отображения компонента.
Left Свойство Left определяет отступ слева при размещении компонента внутри GridPanel.
Opacity Свойство Opacity определяет прозрачность компонента.
Parent Свойство Parent определяет родительский компонент элемента управления.
ParentNode Свойство ParentNode определяет родительскую DOM-вершину.
ResourceKey Свойство ResourceKey определяет ресурсный ключ для компонента.
Right Свойство Right определяет отступ справа при размещении компонента внутри LayoutPanel.
Rotate Свойство Rotate определяет угол поворота компонента.
ShowToolTip Свойство ShowToolTip определяет признак возможности отображения всплывающей подсказки компонента.
Style Свойство Style определяет стиль для компонента.
TabIndex Свойство TabIndex определяет последовательность перехода элемента управления внутри контейнера.
Tag Свойство Tag определяет JSON-объект, ассоциированный с компонентом.
ToolTip Свойство ToolTip определяет текст всплывающей подсказки компонента.
Top Свойство Top определяет отступ сверху при размещении компонента внутри GridPanel.
Value Свойство Value определяет значение компонента.
Width Свойство Width определяет ширину компонента.

Методы, унаследованные от класса Control

  Имя метода Краткое описание

addClass

Метод addClass добавляет CSS-класс к компоненту.
addEventHandler Метод addEventHandler добавляет обработчик события на DOM-вершину.

addStateClass

Метод addStateClass добавляет CSS-класс к компоненту и удаляет прежний CSS-класс.

addToNode

Метод addToNode добавляет компонент в указанную вершину.
bindEvents Метод bindEvents подписывает элемент на все стандартные события.

getAnchorFlags

Метод getAnchorFlags возвращает JSON-объект с настройками текущей позиции компонента.

getClass

Метод getClass возвращает текущие css-классы компонента.

getCssStyle

Метод getCssStyle возвращает стили для указанной вершины.

getDomNode

Метод getDomNode возвращает главную DOM-вершину компонента.

getFocused

Метод getFocused определяет наличие фокуса у компонента.
getIsBinded Метод getIsBinded возвращает признак подписи элемента на события DOM-вершины.

hide

Метод hide скрывает элемент управления.

hideToolTip

Метод hideToolTip очищает таймаут появления подсказки и скрывает её, если она был показана.
refreshStyle Метод refreshStyle обновляет CSS-стили элемента.

removeClass

Метод removeClass удаляет CSS-класс из компонента.
removeEventHandler Метод removeEventHandler удаляет обработчик события DOM-вершины.
removeFromDOM Метод removeFromDOM удаляет вершину из DOM-структуры.

removeStateClasses

Метод removeStateClasses удаляет CSS-классы компонента.

setDraggable

Метод setDraggable устанавливает возможность перетаскивания компонента на HTML-странице.

setFocus

Метод setFocus устанавливает фокус компонента.

setIsHovered

Метод setIsHovered настраивает отображение компонента только при наведении на него курсора.

setSize

Метод setSize устанавливает размеры компонента.

show

Метод show отображает элемент управления.
unBindEvents Метод unBindEvents отписывает элемент от всех стандартных событий.

updatePosition

Метод updatePosition корректирует размер и положение при абсолютном позиционировании на основе текущих параметров.

updateSize

Метод updateSize обновляет размеры компонента подгонке размеров контейнера, в котором находится компонент.

События, унаследованные от класса Control

  Имя события Краткое описание
Drag Событие Drag наступает при нажатии и удерживании кнопки мыши.
DragEnd Событие DragEnd наступает при окончании перетаскивания компонента.
DragStart Событие DragStart наступает, когда начинается перетаскивание компонента.
OnContextMenu Событие OnContextMenu наступает при вызове контекстного меню компонента.
SizeChanged Событие SizeChanged наступает после изменения размеров компонента.
SizeChanging Событие SizeChanging наступает во время изменения размеров компонента.

Свойства, унаследованные от класса Object

  Имя свойства Краткое описание

Id

Свойство Id определяет идентификатор объекта репозитория.

Методы, унаследованные от класса Object

  Имя метода Краткое описание
clone Метод clone создает копию объекта.
dispose Метод dispose уничтожает компонент.
getHashCode Метод getHashCode возвращает хеш-код объекта репозитория.
getId Метод getId возвращает идентификатор объекта репозитория.
getSettings Метод getSettings возвращает настройки объекта репозитория.
getTypeName Метод getTypeName возвращает имя типа объекта без пространства имен, к которому он принадлежит.
isEqual Метод isEqual определяет, равен ли заданный объект текущему объекту репозитория.
isLive Метод isLive определяет действительность объекта репозитория.
removeAllEvents Метод removeAllEvents удаляет все обработчики событий объекта по заданному контексту.
setId Метод setId определяет идентификатор объекта репозитория.
setSettings Метод setSettings задает настройки объекта репозитория.
defineProps Метод defineProps создает методы get и set из массива имен для указанного класса.
keys Метод keys возвращает массив названий методов и свойств для указанного объекта.

См. также:

DHTML-компоненты