AdvancedDataGridColumn  - AS3 Flex

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

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

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

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

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

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

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

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

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

Ниже приведен пример реализации функции. Для ячейки заголовка возвращает «Имя столбца». Для ячеек таблицы возвращает свойство имени объекта:

      private function tipFunc(value:Object):String
      {
          if (value is AdvancedDataGridColumn)
              return "Column Name";
                     
          // Use the 'name' property of the data provider element.
          return "Name: " + value["name"];
      }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Экземпляр подклассов mx.formatters.Formatter. Этот класс используется элементом управления для форматирования текста столбца.

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

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

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

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

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

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

Значение true устанавливается для переноса заголовка столбца, если он не умещается в одной строке. Если значение установлено на undefined, используется свойство wordWrap элемента управления AdvancedDataGrid. Это свойство обеспечивает отмену свойства headerWordWrap элемента управления AdvancedDataGrid.

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

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

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

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

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

Значением по умолчанию является элемент управления mx.controls.TextInput.

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

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

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

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

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

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

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

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

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

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

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

Минимальная ширина столбца в пикселях.

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

function myStyleFunction(data:Object, column:AdvancedDataGridColumn):Object

data – объект данных, связанный с визуализируемым элементом.

column – экземпляр AdvancedDataGridColumn, с которым связано средство визуализации элементов.

Возвращаемым значением должен быть объект со стилями в виде свойств с требуемыми значениями. Например:

{ color:0xFF0000, fontWeight:"bold" }

Если значение установлено на true столбец является видимым. Значение false устанавливается для скрытия столбца.

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

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

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

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

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

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

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

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

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

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

Параметры

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

Параметры