DataGridColumn  - AS3 Flex

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

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

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

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

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

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

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

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

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

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

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

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

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

Имя свойства редактора элемента, содержащего новые данные для элемента списка. Например, по умолчанию свойство itemEditor имеет значение TextInput, таким образом, значением по умолчанию для свойства editorDataField является text, что определяет свойство text элемента управления TextInput.

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

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

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

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

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

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

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

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

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

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

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

Флаг, указывающий на необходимость активации IME при получении компонентом фокуса. Если редактор включен, он соответственно активирует IME.

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

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

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

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

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

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

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

Указывает режим IME (редактор методов ввода). IME позволяет пользователям вводить текст на китайском, японском и корейском языках. Режим IME устанавливается при возникновении события itemFocusIn и возвращается к предыдущему значению, если происходит событие itemFocusOut. Класс flash.system.IMEConversionMode определяет константы для допустимых значений этого свойства.

По умолчанию значение null, в этом случае используется значение свойства imeMode элемента управления DataGrid.

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

Фабрика класса для экземпляров редактора элементов, предназначенная для использования в столбце, если он доступен для редактирования.

Значением по умолчанию является new ClassFactory(mx.controls.TextInput).

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

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

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

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

Для элемента управления DataGrid подпись метода имеет следующую форму:

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

Где item содержит объект элемента DataGrid, а значение column определяет столбец DataGrid.

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

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

Минимальная ширина столбца.

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

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

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

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

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

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

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

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

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

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

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

Флаг, указывающий на наличие или отсутствие у пользователя возможности сортировки в поставщике данных с помощью щелчка по заголовку столбца. Если данное свойство и свойство sortableColumns DataGrid имеют значение true, элемент управления DataGrid обеспечивает передачу события headerRelease, когда пользователь отпускает кнопку мыши на заголовке этого столбца. Если ни один другой обработчик не вызывает метод preventDefault() в событии headerRelease, свойство dataField или sortCompareFunction столбца используется для переупорядочивания элементов в dataProvider.

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

Функция обратного вызова, выполняемая при сортировке данных в столбце. Если это свойство не определено, осуществляется попытка выполнения базовой сортировки данных по строкам или числам. Если данные не являются строкой или числом или если свойство dataField не является допустимым свойством поставщика данных, сортировка не производится или создается исключение. При указании значения свойства labelFunction также обычно необходимо обеспечить функцию для свойства sortCompareFunction, если сортировка для данного столбца не разрешена. Это означает, что функция указывается, если значение dataField столбца не отсортировано аналогично вычисленному значению свойства labelFunction.

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

mySortCompareFunction(obj1:Object, obj2:Object):int 

obj1 – элемент данных для сравнения.

obj2 – другой элемент данных для сравнения с obj1.

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

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

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

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

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

Указывает на то, сортируется столбец в порядке возрастания false или в порядке убывания true.

Установка этого свойства не инициирует начало сортировки; устанавливается лишь направление сортировки. Для выполнения сортировки щелкните в области заголовка столбца.

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

Флаг, указывающий, является ли столбец видимым. Если значение установлено на true столбец является видимым.

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

Ширина столбца в пикселях. Если свойство horizontalScrollPolicy DataGrid имеет значение false, все видимые столбцы должны помещаться в отображаемой области, а элемент управления DataGrid не всегда будет обеспечивать обработку ширины столбцов, если общая ширина столбцов будет слишком маленькой или слишком большой для отображаемой области.

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

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

Флаг, который указывает, будет ли текст строки данного столбца переноситься по словам, если не поместится на одной строке. Если установлено значение undefined, используется свойство wordWrap элемента управления DataGrid.

Оказывает влияние только в том случае, если свойство DataGrid.variableRowHeight также имеет значение true.

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

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

Возвращает соответствующую фабрику с использованием фабрики по умолчанию, если не определена другая.

Параметры

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

Этот метод предназначен для использования разработчиками, создающими подклассы для класса DataGridColumn. Он не должен использоваться разработчиками приложений.

Параметры

Возвращает строку, которая отображается средством визуализации элемента для заданного объекта данных. Если DataGridColumn или его элемент управления DataGrid имеет значение свойства labelFunction, отличное от null, функция применяется к объекту данных. В противном случае, метод обеспечивает извлечение содержимого поля, определяемого в свойстве dataField или получение строкового значения для объекта данных. Если методу не удается преобразовать параметр в строку, возвращается одиночный знак пробела.

Параметры