GridColumn  - AS3 Flex

La position de cette colonne dans la liste des colonnes de la grille, ou -1 si la grille de cette colonne est null.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement columnIndexChanged .

Nom du champ ou de la propriété de l’élément de fournisseur de données associé à la colonne. Chaque GridColumn nécessite que cette propriété ou la propriété labelFunction soit définie afin de calculer le texte affichable pour le rendu d’élément. Si les propriétés dataField et labelFunction sont définies, les données s’affichent à l’aide de la propriété labelFunction et sont triées à l’aide de la propriété dataField.

La valeur de cette propriété n’est pas nécessairement la chaîne qui est affichée dans l’en-tête de colonne. Cette propriété est utilisée uniquement pour accéder aux données dans le fournisseur de données. Pour plus d’informations, voir la propriété headerText.

Si la colonne ou sa grille spécifie une propriété labelFunction, la propriété dataField n’est pas utilisée.

La valeur par défaut est null.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement dataFieldChanged .

Eléments de l’API associés

Nom du champ dans le fournisseur de données à afficher comme astuce sur les données. Par défaut, si showDataTips a la valeur true, le contrôle de grille associé recherche une propriété appelée label sur chaque élément de fournisseur de données et l’affiche. Toutefois, si le fournisseur de données ne contient pas de propriété label, vous pouvez définir la propriété dataTipField pour qu’elle spécifie un autre nom de propriété. Par exemple, vous pouvez définir la valeur sur « FullName » lorsqu’un utilisateur affiche un ensemble de noms de personnes incluses dans une base de données.

GridColumn.dataTipField est prioritaire par rapport à cette propriété.

Si cette colonne ou sa grille spécifie une valeur pour la propriété dataTipFunction, la propriété dataTipField est ignorée.

La valeur par défaut est null.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement dataTipFieldChanged .

Eléments de l’API associés

Spécifie l’outil de formatage utilisé par la méthode itemToDataTip() de la colonne pour convertir les éléments de fournisseur de données en chaînes.

Si l’élément styleParent de l’outil de formatage n’a pas été spécifié, il est défini sur la grille de la colonne, de sorte que l’outil de formatage hérite du style locale de la grille.

La valeur par défaut est null.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement dataTipFormatterChanged .

Eléments de l’API associés

Indique une fonction de rappel à exécuter sur chaque élément du fournisseur de données afin d’en déterminer les astuces sur les données. Cette propriété est utilisée par la méthode itemToDataTip.

Par défaut, si showDataTips a la valeur true, la colonne recherche une propriété nommée label sur chaque élément de fournisseur de données et l’affiche comme son astuce de données. Toutefois, certains fournisseurs de données n’ont pas de propriété label ni aucune autre propriété que vous pouvez utiliser pour afficher les données dans les rangées.

Par exemple, vous disposez d’un fournisseur de données contenant les champs lastName et firstName, mais vous souhaitez afficher les noms complets en tant qu’astuce de données. Vous pouvez spécifier une fonction pour la propriété dataTipFunction qui renvoie une seule chaîne contenant la valeur des deux champs. Vous pouvez également utiliser la propriété dataTipFunction pour gérer la mise en forme et la localisation.

La signature de la fonction dataTipFunction doit correspondre à la suivante :

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

Une fonction standard peut concaténer les propriétés firstName et lastName d’un élément ou personnaliser la mise en forme d’une propriété de valeur de date.

La valeur par défaut est null.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement dataTipFunctionChanged .

Eléments de l’API associés

Indique si les éléments de la colonne peuvent être modifiés. Si la valeur est true et si la propriété editable de la grille associée a également la valeur true, les éléments d’une colonne sont modifiables et peuvent être modifiés individuellement en cliquant sur un élément sélectionné ou en naviguant jusqu’à lui et en appuyant sur la touche F2.

La valeur par défaut est true.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement editableChanged .

Spécifie l’outil de formatage utilisé par la méthode itemToLabel() de la colonne pour convertir les éléments de fournisseur de données en chaînes.

Si l’élément styleParent de l’outil de formatage n’a pas été spécifié, il est défini sur la grille de la colonne, de sorte que l’outil de formatage hérite du style locale de la grille.

La valeur par défaut est null.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement formatterChanged .

Eléments de l’API associés

L’objet Grid associé à cette colonne.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement gridChanged .

Fabrique de classe de la classe IGridItemRenderer utilisée comme en-tête de cette colonne. Si elle n’est pas spécifiée, la partie d’habillage columnHeaderGroup du contrôle DataGrid définit le rendu d’en-tête par défaut.

La valeur par défaut est null.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement headerRendererChanged .

Eléments de l’API associés

Texte de l’en-tête de cette colonne. Par défaut, le contrôle de grille associé utilise la valeur de la propriété dataField en tant que texte d’en-tête.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement headerTextChanged .

Spécifie le mode IME (éditeur de méthode d’entrée). L’éditeur IME permet aux utilisateurs d’entrer du texte en chinois, japonais et coréen. Flex définit le mode IME spécifié lorsque le contrôle est mis en focus et rétablit la valeur précédente lorsque le contrôle est désactivé.

La classe flash.system.IMEConversionMode définit des constantes pour les valeurs possibles de cette propriété. Vous pouvez également spécifier null si vous ne souhaitez pas spécifier d’éditeur IME.

La valeur par défaut est null.

Eléments de l’API associés

Fabrique de classe pour la classe IGridItemEditor utilisée pour modifier les cellules de grille individuelles dans cette colonne. Si la valeur de cette propriété est null et que le propriétaire de la grille de colonne est un contrôle DataGrid, la valeur de la propriété itemEditor du contrôle DataGrid est utilisée. Si aucun éditeur d’élément n’est spécifié par le contrôle DataGrid, utilisez la classe DefaultGridItemEditor.

L’éditeur d’élément par défaut est la classe DefaultGridItemEditor, qui vous permet de modifier un champ de texte simple. Vous pouvez créer des rendus d’élément personnalisés en créant une sous-classe de la classe GridItemEditor. Votre éditeur d’élément personnalisé peut écrire des données dans la rangée entière de la grille pour définir un éditeur plus complexe.

La valeur par défaut est null.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement itemEditorChanged .

Eléments de l’API associés

Fabrique de classe de la classe IGridItemRenderer utilisée pour effectuer le rendu des cellules de grille individuelles. Si elle n’est pas spécifiée, utilisez la valeur de la propriété itemRenderer issue du contrôle de grille associé.

Le rendu d’élément par défaut est la classe AdvancedDataGridItemRenderer, qui affiche l’élément de données sous forme de texte. Vous pouvez créer des rendus d’élément personnalisés en créant une sous-classe de la classe GridItemRenderer. Votre rendu d’élément personnalisé peut accéder aux données de la rangée entière de la grille pour définir une représentation visuelle plus complexe de la cellule.

La valeur par défaut est la valeur de la propriété itemRenderer issue du contrôle de grille associé, ou null.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement itemRendererChanged .

Eléments de l’API associés

Si elle est spécifiée, la valeur de cette propriété doit être une fonction idempotent qui renvoie un rendu d’élément IFactory en fonction de ses paramètres de colonne et d’élément de fournisseur de données. La spécification d’une valeur pour la propriété itemRendererFunction permet d’utiliser plusieurs rendus d’élément dans cette colonne.

La fonction spécifiée pour la propriété itemRendererFunction doit présenter la signature suivante :

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

Le paramètre item est l’élément de fournisseur de données d’une rangée entière. Le second paramètre est cet objet de colonne.

Vous trouverez ci-dessous un exemple de fonction de rendu d’élément :

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

La valeur par défaut est null.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement itemRendererFunctionChanged .

Fonction idempotent qui convertit un élément de fournisseur de données en chaîne spécifique à une colonne qui permet d’initialiser la propriété label du rendu d’élément.

Vous pouvez utiliser une fonction d’étiquette pour combiner les valeurs de plusieurs éléments fournisseurs de données en une chaîne unique. Si elle est spécifiée, cette propriété est utilisée par la méthode itemToLabel(), qui calcule la valeur de la propriété label de chaque rendu d’élément dans cette colonne.

La fonction spécifiée pour la propriété labelFunction doit présenter la signature suivante :

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

Le paramètre item est l’élément de fournisseur de données d’une rangée entière. Le second paramètre est cet objet de colonne.

Une fonction standard peut concaténer les propriétés firstName et lastName de l’élément de fournisseur de données ou personnaliser la mise en forme d’une propriété de valeur de date.

La valeur par défaut est null.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement labelFunctionChanged .

Eléments de l’API associés

La largeur maximale de cette colonne en pixels. Si elle est spécifiée, la présentation de la grille spécifie comme largeur de la présentation de la colonne la plus petite valeur entre typicalItem et maxWidth. Si cette colonne est redimensionnable, cette propriété limite la largeur que l’utilisateur peut donner à la colonne. La définition de cette propriété ne change pas les propriétés width ni minWidth.

La valeur par défaut est NaN.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement maxWidthChanged .

La largeur minimale de cette colonne en pixels. Si elle est spécifiée, la présentation de la grille spécifie comme largeur de la présentation de la colonne la plus grande valeur entre typicalItem et minWidth. Si cette colonne est redimensionnable, cette propriété limite la grandeur que l’utilisateur peut donner à la colonne. La définition de cette propriété ne change pas les propriétés width ni maxWidth.

La valeur par défaut est 20.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement minWidthChanged .

Détermine si des contrôles du rendu d’élément sont modifiables. Si la colonne est modifiable, les contrôles pouvant recevoir le focus dans le rendu d’élément reçoivent le focus clavier lorsque l’utilisateur commence à modifier le rendu d’élément.

Lorsque vous définissez cette propriété sur true, la cellule devient modifiable quand l’utilisateur clique à l’intérieur de cette dernière. Etant donné que la cellule est modifiable, le composant DataGrid affiche la partie d’habillageeditorIndicator en haut de la partie d’habillageselectionIndicator. Par conséquent, l’utilisateur ne voit pas l’indicateur de sélection de la cellule jusqu’à ce que la session de modification soit terminée. Vous pouvez créer un habillage personnalisé pour supprimer ou modifier la partie d’habillage editorIndicator, de sorte que la partie d’habillage selectionIndicator s’affiche. Par exemple, vous pouvez définir la propriété alpha deeditorIndicator de sorte que selectionIndicator transparaisse, ou modifier la taille de editorIndicator pour qu’il soit plus petit que la cellule.

En définissant cette propriété sur true, vous assumez la responsabilité de la validation et de l’enregistrement de l’entrée recueillie par le rendu d’élément. Si le rendu d’élément contient un remplacement de la méthode IGridItemRenderer.prepare(), vous devez vous assurer que les modifications du champ d’entrée non enregistrées ne sont pas remplacées. Par exemple, rendererIsEditable a la valeur true et le rendu contient un élément TextInput unique qui affiche la valeur de data.myDataField. Si la méthode prepare() du rendu définit la propriété text du contrôle TextInput, la méthode prepare() ne doit pas définir la propriété text lorsqu’il existe des modifications en attente.

La valeur par défaut est false.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement rendererIsEditableChanged .

Indique si l’utilisateur est autorisé à redimensionner la largeur de la colonne. Si la valeur est true et que la propriété resizableColumns de la grille associée a également la valeur true, l’utilisateur peut faire glisser les rangées de la grille entre les en-têtes des colonnes pour redimensionner la colonne.

La valeur par défaut est true.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement resizableChanged .

Indique si les astuces sur les données sont affichées dans la colonne. Si la valeur est true, les astuces sur les données s’affichent pour le texte des rangées. Les astuces sur les données sont des infos-bulles conçues pour afficher le texte qui est trop long pour la rangée.

Si la valeur de cette propriété n’est pas définie (configuration par défaut), la propriété showDataTips de la grille associée détermine si les astuces sur les données sont affichées. Si cette propriété est définie, la propriété showDataTips de la grille est ignorée.

La valeur par défaut est undefined.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement showDataTipsChanged .

Eléments de l’API associés

Si la valeur est true et si le fournisseur de données de la grille est un objet ICollectionView, et si la propriété sortableColumns de la grille associée a la valeur true, cette colonne prend en charge le tri interactif. En règle générale, l’en-tête de la colonne gère les clics de souris en définissant la propriété sort du fournisseur de données sur un objet Sort dont l’objet SortField est la propriété dataField de cette colonne.

Si le fournisseur de données n’est pas un objet ICollectionView, cette propriété n’a aucun effet.

La valeur par défaut est true.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement sortableChanged .

La fonction qui compare deux éléments lors d’un tri sur les éléments de données de cette colonne. Si vous spécifiez une valeur pour la propriété labelFunction, en règle générale, vous fournissez également une propriété sortCompareFunction.

La signature de la propriété sortCompareFunction doit correspondre aux éléments suivants :

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

La fonction doit renvoyer une valeur basée sur la comparaison des objets :

• -1 si obj1 doit apparaître avant obj2 par ordre croissant.
• 0 si obj1 = obj2.
• 1 si obj1 doit apparaître après obj2 par ordre croissant.

La fonction peut utiliser le paramètre de colonne pour écrire des fonctions de comparaison génériques.

Remarque : les paramètres obj1 et obj2 sont des éléments entiers du fournisseur de données et pas uniquement les données de l’élément.

Si l’objet dataProvider n’est pas un objet ICollectionView, cette propriété n’a aucun effet.

La valeur par défaut est null.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement sortCompareFunctionChanged .

Si la valeur est true, cette colonne est triée dans l’ordre décroissant. Par exemple, si la propriété dataField de la colonne contient une valeur numérique, la première rangée serait celle dotée de la plus grande valeur pour cette colonne.

La définition de cette propriété ne permet pas de lancer un tri, mais seulement de définir le sens du tri. Lorsque la méthode dataProvider.refresh() est appelée, le tri est réalisé.

Si le fournisseur de données n’est pas un objet ICollectionView, cette propriété n’a aucun effet.

La valeur par défaut est false.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement sortDescendingChanged .

Renvoie un objet SortField qui peut être utilisé pour trier une collection par la propriété dataField de cette colonne.

Si la propriété sortCompareFunction est définie, alors la propriété compareFunction de SortField est automatiquement définie.

Si la propriété propriété sortCompareFunction n’est pas définie et que la propriété dataField est complexe, la fonction de comparaison SortField est affectée à une fermeture autour d’une fonction de comparaison par défaut qui gère la propriété dataField complexe.

Si les propriétés sortCompareFunction et dataField ne sont pas définies, mais que la propriété labelFunction est définie, elle affecte compareFunction à une fermeture qui effectue une comparaison de chaîne de base sur la propriété labelFunction appliquée aux objets de données.

Eléments de l’API associés

Si la valeur est true, affichez cette colonne. Si la valeur est false, aucun espace ne sera alloué pour cette colonne. Elle ne sera pas incluse dans la présentation.

La valeur par défaut est true.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement visibleChanged .

La largeur de cette colonne en pixels. Si elle est spécifiée, la présentation de la grille ignore sa propriété typicalItem et les propriétés minWidth et maxWidth de cette colonne.

La valeur par défaut est NaN.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement widthChanged .

Constructeur.

Convertissez l’élément de fournisseur de données spécifié en chaîne datatip spécifique à une colonne.

Cette méthode utilise les valeurs dataTipField et dataTipFunction. Si ces propriétés ont la valeur null, elle utilise les propriétés correspondantes à partir du contrôle de grille associé. Si les propriétés dataTipField ont également la valeur null dans le contrôle de grille, utilisez la propriété dataField.

Si dataTipFunction et dataTipFormatter sont null, cette méthode sa valeur est identique à : élément[dataTipField].toString(). Si dataTipFormatter est spécifié, cette méthode sa valeur est identique à : dataTipFormatter.format(élément[dataTipField]) si la résolution des l’élément dataField entraîne le renvoi d’une erreur, ERROR_TEXT est renvoyé.

Si item et dataTipFunction n’ont pas la valeur null, cette méthode renvoie dataTipFunction(item,this), où le second argument est cette classe GridColumn.

Paramètres

Convertissez l’élément de fournisseur de données spécifié en chaîne spécifique à une colonne. Cette méthode est utilisée pour initialiser la propriété label des rendus d’élément.

Si labelFunction a la valeur null et que la propriété dataField est une chaîne qui ne contient pas de caractères "." Nom du champ caractères de séparation et formateur est null, cette méthode équivaut à la suivante :

item[dataField].toString()

Si l’outil de formatage a été spécifiée, cette méthode sa valeur est :

formatter.format(item[dataField])

Si la propriété dataField est un chemin "." séparé, cette méthode recherche chaque élément de chemin successif. Par exemple, si ="foo.bar.baz", cette méthode renvoie une chaîne basée sur la valeur de item.foo.bar.baz. Si la résolution de la propriété dataField de l’élément génère une erreur, ERROR_TEXT est renvoyé.

Si item et labelFunction n’ont pas la valeur null, cette méthode renvoie labelFunction(item, this), où le second argument est cette classe GridColumn.

Paramètres

Convertissez l’élément de fournisseur de données spécifié en fabrique de rendu d’élément spécifique à une colonne. Par défaut, cette méthode appelle itemRendererFunction si cette fonction n’est pas null, et dans le cas contraire elle renvoie simplement la valeur de la propriété itemRenderer de la colonne.

Paramètres

La valeur de retour de la méthode itemToLabel() ou itemToDataTip() en cas d’échec de la résolution du nom (chemin) de la propriété correspondante. La valeur de cette constante est une chaîne composée d’un espace unique : " ".

Eléments de l’API associés