GridColumn  - AS3 Flex

Позиция этого столбца в списке столбцов сетки или -1, если сетка этого столбца - null.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие columnIndexChanged .

Имя поля или свойства элемента поставщика данных, связанного со столбцом. Данное свойство или свойство labelFunction необходимо установить для каждого GridColumn, чтобы вычислить отображаемый текст для средства визуализации элементов. Если установлено значение свойств dataField и labelFunction, данные отображаются с помощью labelFunction и сортируются с применением dataField.

Это значение данного свойства не обязательно является строкой, отображаемой в заголовке столбца. Это свойство используется только для получения доступа к данным в поставщике данных. Дополнительную информацию см. в описании свойства headerText.

Если в столбце или его сетке указано свойство labelFunction, то dataField не используется.

Значением по умолчанию является null.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие dataFieldChanged .

Связанные элементы API

Имя поля в поставщике данных для отображения в качестве всплывающей подсказки. Если для showDataTips указано значение true, то связанный элемент управления сетки по умолчанию выполняет поиск свойства с именем label в каждом элементе поставщика данных и отображает его. Однако если поставщик данных не содержит свойство label, можно установить свойство dataTipField для определения другого имени свойства. Например, если пользователь просматривает группу имен лиц, извлеченных из базы данных, может быть установлено значение FullName.

GridColumn.dataTipField имеет приоритет над этим свойством.

Если в столбце или его сетке указано значение для свойства dataTipFunction, то свойство dataTipField игнорируется.

Значением по умолчанию является null.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие dataTipFieldChanged .

Связанные элементы API

Указывает средство форматирования, используемое методом столбца itemToDataTip() для преобразования элементов поставщика данных в строки.

Если styleParent средства форматирования не указан, он устанавливается как сетка столбца и средство форматирования наследует стиль locale сетки.

Значением по умолчанию является null.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие dataTipFormatterChanged .

Связанные элементы API

Определяет функцию обратного вызова, выполняемую в каждом элементе поставщика данных для определения всплывающей подсказки. Это свойство используется методом itemToDataTip.

Если для showDataTips указано значение true, то столбец по умолчанию выполняет поиск свойства с именем label в каждом элементе поставщика данных и отображает его как всплывающую подсказку. Однако для некоторых поставщиков данных не определено свойство label или другие свойства, используемые для отображения данных в строках.

Например, существует поставщик данных, содержащий поля lastName и firstName, но в качестве всплывающей подсказки требуется отображение полных имен. Для свойства dataTipFunction можно определить функцию, возвращающую отдельную строку, содержащую значения обоих полей. Для обработки форматирования и локализации также можно использовать свойство dataTipFunction.

Для функции dataTipFunction необходимо определить следующую подпись:

dataTipFunction(item:Object, column:GridColumn):String

Типичная функция может связывать свойства firstName и lastName элемента или выполнять пользовательское форматирование в свойстве со значением Date.

Значением по умолчанию является null.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие dataTipFunctionChanged .

Связанные элементы API

Определяет, являются ли элементы в столбце редактируемыми. Если установлено значение true и свойство editable связанной сетки также имеет значение true, элементы столбца доступны для редактирования и для их редактирования по отдельности необходимо выбрать требуемый элемент с помощью мыши или перейти к нему с использованием клавиши F2.

Значением по умолчанию является true.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие editableChanged .

Указывает средство форматирования, используемое методом столбца itemToLabel() для преобразования элементов поставщика данных в строки.

Если styleParent средства форматирования не указан, он устанавливается как сетка столбца и средство форматирования наследует стиль locale сетки.

Значением по умолчанию является null.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие formatterChanged .

Связанные элементы API

Объект Grid, связанный с этим столбцом.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие gridChanged .

Фабрика для класса IGridItemRenderer, используемая в качестве заголовка столбца. При неопределенном значении компонент темы оформления columnHeaderGroup элемента управления DataGrid определяет стандартное средство визуализации заголовка.

Значением по умолчанию является null.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие headerRendererChanged .

Связанные элементы API

Текст заголовка данного столбца. По умолчанию значение свойства dataField используется связанным элементом управления Grid в качестве текста заголовка.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие headerTextChanged .

Указывает режим IME (редактор методов ввода). IME позволяет пользователям вводить текст на китайском, японском и корейском языках. Режим IME устанавливается при перемещении фокуса на элемент управления и возвращается к предыдущему значению при потере фокуса этим элементом управления.

Класс flash.system.IMEConversionMode определяет константы для допустимых значений этого свойства. Можно также указать значение null и не указывать IME.

Значением по умолчанию является null.

Связанные элементы API

Фабрика для класса IGridItemEditor, которая используется для редактирования отдельных ячеек сетки в столбце. Если для свойства указано значение null и владелец сетки столбца представлен элементом управления DataGrid, то используется значение свойства itemEditor элемента управления DataGrid. Если редактор элементов не указан элементом управления DataGrid, следует использовать класс DefaultGridItemEditor.

Редактор элементов по умолчанию представлен классом DefaultGridItemEditor, с помощью которого редактируется поле обычного текста. Для создания пользовательских средств визуализации элементов используются подклассы класса GridItemEditor. Пользовательский редактор элементов может записывать данные во всей строке сетки, чтобы определить расширенный редактор.

Значением по умолчанию является null.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие itemEditorChanged .

Связанные элементы API

Фабрика для класса IGridItemRenderer, используемая для отображения отдельных ячеек сетки. Если значение не указано, используется значение свойства itemRenderer из связанного элемента управления сетки.

Средством визуализации элементов по умолчанию является класс DefaultGridItemRenderer, отображающий элемент данных в виде текста. Для создания пользовательских средств визуализации элементов используются подклассы класса GridItemRenderer. Пользовательское средство визуализации элементов может выполнять доступ к данным из всей строки сетки, чтобы определить расширенное визуальное представление сетки.

Значением по умолчанию является значение свойства itemRenderer из связанного элемента управления сетки или null.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие itemRendererChanged .

Связанные элементы API

Если выбрано значение этого свойства, оно должно быть идемпотентной функцией, возвращающей IFactory средства визуализации элементов на основе объекта поставщика данных и параметром столбцов. При указании значения для свойства itemRendererFunction можно использовать более одного редактора элементов в этом столбце.

Функция, указанная для свойства itemRendererFunction, должна иметь следующую подпись:

itemRendererFunction(item:Object, column:GridColumn):IFactory

Параметр item является элементом поставщика данных для всей строки. Второй параметр представлен этим объектом столбца.

Ниже приведен пример функции редактора элементов:

      function myItemRendererFunction(item:Object, column:GridColumn):IFactory
      {
          return (item is Array) ? myArrayItemRenderer : myItemRenderer;
      }
      

Значением по умолчанию является null.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие itemRendererFunctionChanged .

Идемпотентная функция, преобразующая элемент поставщика данных в зависящую от столбца строку, используемую для инициализации свойства label средства визуализации.

Функция label используется для объединения значений различных поставщиков данных в одной строке. Если указано, то это свойство используется методом itemToLabel(), который вычисляет значение каждого свойства label средства визуализации элементов в этом столбце.

Функция, указанная для свойства labelFunction, должна иметь следующую подпись:

labelFunction(item:Object, column:GridColumn):String

Параметр item является элементом поставщика данных для всей строки. Второй параметр представлен этим объектом столбца.

Типичная функция label может связывать свойства firstName и lastName элемента поставщика данных или выполнять пользовательское форматирование в свойстве со значением Date.

Значением по умолчанию является null.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие labelFunctionChanged .

Связанные элементы API

Максимальная ширина столбца в пикселах. Если значение указано, макет сетки применяет меньшее из значений ширины typicalItem и maxWidth к ширине макета столбца. Если этот размер этого столбца может изменяться, то это свойство ограничивает ширину столбца, которую может указать пользователь. Установка этого свойства не изменит свойства width или minWidth.

Значением по умолчанию является NaN.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие maxWidthChanged .

Минимальная ширина столбца в пикселах. Если значение указано, макет сетки применяет большее из значений ширины typicalItem и minWidth к ширине макета столбца. Если этот размер этого столбца может изменяться, то это свойство ограничивает минимальный размер столбца, который может указать пользователь. Установка этого свойства не изменит свойства width или maxWidth.

Значением по умолчанию является 20.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие minWidthChanged .

Определяет возможность редактирования элементов управления средства визуализации элементов. Если столбец доступен для редактирования, фокусируемые элементы управления в средстве визуализации элементов получают фокус клавиатуры, когда пользователь начинает редактирование средства визуализации.

При установке для этого свойства значения true ячейка, в пределах которой пользователь щелкает кнопкой мыши, становится редактируемой. Поскольку ячейка доступна для редактирования, DataGrid отображает компонент темы оформления editorIndicator поверх компонента темы оформления selectionIndicator. Поэтому индикатор для выбора ячейки отображается только после завершения сеанса редактирования. В пользовательской теме оформления можно удалить или изменить компонент темы оформления editorIndicator, чтобы отобразить компонент selectionIndicator. Например, измените свойство alpha компонента editorIndicator для отображения selectionIndicator или установите размер editorIndicator меньше размера ячейки.

При установке для этого свойства значения true пользователь должен обеспечить проверку и сохранение введенных данных, которые собраны средством визуализации элементов. Если средство визуализации элементов содержит переопределение метода IGridItemRenderer.prepare(), необходимо удостовериться, что несохраненные изменения полей ввода не переопределены. Например, rendererIsEditable имеет значение true и средство визуализации содержит один элемент TextInput, который отображает значение data.myDataField. Если метод prepare() средства визуализации устанавливает свойство text элемента управления TextInput, то метод prepare() не должен устанавливать свойство text при наличии изменений в состоянии ожидания.

Значением по умолчанию является false.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие rendererIsEditableChanged .

Указывает, разрешено ли пользователю изменять ширину столбца. Если true и свойство resizableColumns связанной сетки также имеет значение true, пользователь может перетаскивать линии сетки между заголовками столбца для изменения размера столбца.

Значением по умолчанию является true.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие resizableChanged .

Определяет, отображаются ли всплывающие подсказки в столбце. Если установлено значение true, всплывающие подсказки для текста отображаются в строках. Datatips – это всплывающие подсказки, указывающие на то, что текст является слишком длинным для этой строки.

Если значение этого свойства не указано, то по умолчанию свойство showDataTips связанной сетки определяет, будут ли отображаться всплывающие подсказки. Если это свойство указано, свойство showDataTips сетки игнорируется.

Значением по умолчанию является undefined.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие showDataTipsChanged .

Связанные элементы API

Если true и поставщик данных сетки представлен ICollectionView, а также если свойство sortableColumns связанной сетки имеет значение true, то этот столбец поддерживает интерактивную сортировку. Как правило, заголовок столбца обрабатывает нажатия кнопки мыши посредством установки свойства sort поставщика данных в объекте Sort, SortField которого представлен dataField этого столбца.

Если поставщик данных не является ICollectionView, то это свойство не оказывает влияния.

Значением по умолчанию является true.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие sortableChanged .

Функция, которая сравнивает два элемента во время сортировки элементов данных в столбце. Если указывается значение свойства labelFunction, обычно необходимо указать sortCompareFunction.

Подпись sortCompareFunction должна соответствовать следующему:

sortCompareFunction(obj1:Object, obj2:Object, column:GridColumn):int

Функция должна возвратить значение, полученное на основе сравнения объектов:

• -1, если obj1 должен отображаться перед obj2 в порядке возрастания.
• 0, если obj1 = obj2.
• 1, если obj1 должен отображаться после obj2 в порядке возрастания.

Функция может использовать параметр столбца для записи общих функций сравнения.

Примечание. Параметры obj1 и obj2 являются едиными элементами поставщика данных, а не только данными элемента.

Если dataProvider не является ICollectionView, то это свойство не действует.

Значением по умолчанию является null.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие sortCompareFunctionChanged .

Если true, для этого столбца выполняется сортировка по убыванию. Например, если dataField столбца содержит числовое значение, то в первой строке будет указано наиболее высокое значение в этом столбце.

Установка этого свойства не инициирует начало сортировки; устанавливается лишь направление сортировки. Сортировка выполняется при вызове метода dataProvider.refresh().

Если поставщик данных не является ICollectionView, то это свойство не оказывает влияния.

Значением по умолчанию является false.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие sortDescendingChanged .

Возвращает SortField, используемый для сортировки коллекции по dataField столбца.

Если определено свойство sortCompareFunction, автоматически устанавливается compareFunction SortField.

Если свойство sortCompareFunction не указано и dataField представлен сложными данными, функция сравнения SortField присваивается закрытию в функции сравнения по умолчанию, которая обрабатывает сложный dataField.

Если свойства sortCompareFunction и dataField не указаны, но определено свойство labelFunction, то оно присваивает compareFunction закрытию, которое выполняет базовое сравнение строк в labelFunction, примененной к объектам данных.

Связанные элементы API

Если true, этот столбец отображается. Если false, место для этого столбца не назначается и он будет отсутствовать в макете.

Значением по умолчанию является true.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие visibleChanged .

Ширина столбца в пикселах. Если значение указано, макет сетки игнорирует свое свойство typicalItem и свойства minWidth и maxWidth этого столбца.

Значением по умолчанию является NaN.

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие widthChanged .

Конструктор.

Преобразование указанного элемента поставщика данных в зависящую от столбца строку datatip.

Этот метод использует значения dataTipField и dataTipFunction. Если для свойств указано значение null, он использует соответствующие свойства из связанного элемента управления сетки. Если для свойства dataTipField также указано значение null в элементе управления сетки, то следует использовать свойство dataField.

Если значение dataTipFunction и dataTipFormatter равно null, то значение этого метода аналогично item[dataTipField].toString(). Если указан dataTipFormatter, значение этого метода аналогично dataTipFormatter.format(item[dataTipField]). Если при обработке dataField элемента возникает ошибка, возвращается ERROR_TEXT.

Если свойства item и dataTipFunction имеют ненулевое значение, то этот метод возвращает dataTipFunction(item, this), где вторым аргументом является GridColumn.

Параметры

Преобразование указанного элемента поставщика данных в зависящую от столбца строку. Этот метод используется для инициализации свойства label средства визуализации элементов.

Если для labelFunction указано значение null и dataField является строкой, не содержащей символы сепаратора имени поля, и форматтер - null, тогда этот метод эквивалентен:

item[dataField].toString()

Если форматтер был указан, то значение этого метода:

formatter.format(item[dataField])

Если dataField представлен отдельным путем ".", то этот метод выполняет поиск каждого последовательного элемента пути. Например, если ="foo.bar.baz", этот метод возвращает строку на основе значения item.foo.bar.baz. Если при обработке dataField элемента возникает ошибка, возвращается ERROR_TEXT.

Если item и labelFunction не являются null, то этот метод возвращает labelFunction(item, this), где вторым аргументом является этот GridColumn.

Параметры

Преобразование указанного элемента поставщика данных в зависящую от столбца фабрику средства визуализации элементов. По умолчанию этот метод вызывает itemRendererFunction, если его значение не null, в противном случае он возвращает значение свойства itemRenderer столбца.

Параметры

Возвращаемое значение метода itemToLabel() или itemToDataTip(), если не удается обработать соответствующее имя (путь) свойства. Значение этой константы - строка с одиночным пробелом: " ".

Связанные элементы API