| Paket | spark.components.gridClasses |
| Klasse | public class GridColumn |
| Vererbung | GridColumn  EventDispatcher Object |
| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
MXML-Syntax anzeigen
MXML-Syntax ausblendenThe <s:GridColumn> tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
<s:GridColumn
Properties
dataField="null"
dataTipField="null"
dataTipFormatter="null"
dataTipFunction="null"
editable="true"
formatter="null"
headerRenderer="null"
headerText="value of dataField"
imeMode="null"
itemEditor="null"
itemRenderer="null"
itemRendererFunction="null"
labelFunction="null"
maxWidth="NaN"
minWidth="20"
rendererIsEditable="false"
resizeable="true"
showDataTips="undefined"
sortable="true"
sortCompareFunction="null"
sortDescending="false"
visible="true"
width="NaN"
/>
Verwandte API-Elemente
| Eigenschaft | Definiert von | ||
|---|---|---|---|
| columnIndex : int [schreibgeschützt]
Die Position dieser Spalte in der Spaltenliste des Rasters oder „-1“, wenn das Raster dieser Spalte „null“ ist. | GridColumn | ||
 | constructor : Object
Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz. | Object | |
| dataField : String
Der Name des Feldes bzw. der Eigenschaft im Datenproviderelement, das bzw. die mit der Spalte verknüpft ist. | GridColumn | ||
| dataTipField : String
Der Name des Felds im Datenprovider, das als Datentipp angezeigt werden soll. | GridColumn | ||
| dataTipFormatter : IFormatter
Legt die von der itemToDataTip()-Methode der Spalte verwendete Formatierung fest, um Datenproviderelemente in Strings zu konvertieren. | GridColumn | ||
| dataTipFunction : Function
Legt eine Rückruffunktion fest, die mit jedem Element des Datenproviders ausgeführt werden muss, um seinen Datentipp zu ermitteln. | GridColumn | ||
| editable : Boolean
Gibt an, ob die Elemente in der Spalte bearbeitet werden können. | GridColumn | ||
| formatter : IFormatter
Legt die von der itemToLabel()-Methode der Spalte verwendete Formatierung fest, um Datenproviderelemente in Strings zu konvertieren. | GridColumn | ||
| grid : Grid [schreibgeschützt]
Das mit dieser ganzen Spalte verknüpfte Grid-Objekt. | GridColumn | ||
| headerRenderer : IFactory
Die Klassen-Factory für die IGridItemRenderer-Klasse, die als Überschrift für diese Spalte verwendet wird. | GridColumn | ||
| headerText : String
Der Text der Spaltenüberschrift. | GridColumn | ||
| imeMode : String
Gibt den Modus des Eingabemethodeneditors (IME) an. | GridColumn | ||
| itemEditor : IFactory
Eine Klassen-Factory für die IGridItemEditor-Klasse, die zum Bearbeiten einzelner Rasterzellen in dieser Spalte verwendet wird. | GridColumn | ||
| itemRenderer : IFactory
Die Klassen-Factory für die IGridItemRenderer-Klasse, die zum Darstellen einzelner Rasterzellen verwendet wird. | GridColumn | ||
| itemRendererFunction : Function
Wenn der Wert dieser Eigenschaft festgelegt wurde, muss er eine idempotente Funktion sein, die basierend auf dem Datenproviderelement und den Spaltenparametern eine Elementrenderer-IFactory zurückgibt. | GridColumn | ||
| labelFunction : Function
Eine idempotente Funktion, die ein Datenproviderelement in einen spaltenspezifischen String konvertiert, mit dem die label-Eigenschaft des Elementrenderers initialisiert wird. | GridColumn | ||
| maxWidth : Number
Die maximale Breite dieser Spalte in Pixeln. | GridColumn | ||
| minWidth : Number
Die minimale Breite dieser Spalte in Pixeln. | GridColumn | ||
| rendererIsEditable : Boolean
Bestimmt, ob die Steuerelemente des Elementrenderers bearbeitet werden können. | GridColumn | ||
| resizable : Boolean
Gibt an, ob die Spaltenbreite vom Benutzer geändert werden kann. | GridColumn | ||
| showDataTips : *
Gibt an, ob die Datentipps in der Spalte angezeigt werden. | GridColumn | ||
| sortable : Boolean
Wenn „true“ festgelegt ist, der Datenprovider des Rasters eine ICollectionView ist und die sortableColumns-Eigenschaft des zugehörigen Rasters „true“ lautet, unterstützt diese Spalte interaktives Sortieren. | GridColumn | ||
| sortCompareFunction : Function
Funktion, die beim Sortieren der Datenelemente dieser Spalte zwei Elemente vergleicht. | GridColumn | ||
| sortDescending : Boolean
Wenn „true“, wird diese Spalte in absteigender Reihenfolge sortiert. | GridColumn | ||
| sortField : SortField [schreibgeschützt]
Gibt ein SortField zurück, mit dem eine Sammlung nach dem dataField dieser Spalte sortiert werden kann. | GridColumn | ||
| visible : Boolean
Wenn „true“, Spalte anzeigen. | GridColumn | ||
| width : Number
Die Breite dieser Spalte in Pixeln. | GridColumn | ||
| Methode | Definiert von | ||
|---|---|---|---|
GridColumn(columnName:String = null)
Konstruktor. | GridColumn | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registriert ein Ereignis-Listener-Objekt bei einem EventDispatcher-Objekt, sodass der Listener über ein Ereignis benachrichtigt wird. | EventDispatcher | |
|
Sendet ein Ereignis in den Ereignisablauf. | EventDispatcher | |
|
Überprüft, ob das EventDispatcher-Objekt Listener für einen bestimmten Ereignistyp registriert hat. | EventDispatcher | |
|
Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde. | Object | |
|
Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde. | Object | |
Konvertiert das angegebene Datenproviderelement in einen spaltenspezifischen Datentipp-String. | GridColumn | ||
Konvertiert das angegebene Datenproviderelement in einen spaltenspezifischen String. | GridColumn | ||
Konvertiert das angegebene Datenproviderelement in eine spaltenspezifische Elementrenderer-Factory. | GridColumn | ||
|
Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann. | Object | |
|
Entfernt einen Listener aus dem EventDispatcher-Objekt. | EventDispatcher | |
|
Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest. | Object | |
|
Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas. | Object | |
|
Gibt das angegebene Objekt als String zurück. | Object | |
|
Gibt den Grundwert des angegebenen Objekts zurück. | Object | |
|
Überprüft, ob bei diesem EventDispatcher-Objekt oder bei einem seiner Vorgänger ein Ereignis-Listener für einen bestimmten Ereignistyp registriert ist. | EventDispatcher | |
| Konstante | Definiert von | ||
|---|---|---|---|
| ERROR_TEXT : String = "unknown" [statisch]
Der Rückgabewert für die itemToLabel()- oder itemToDataTip()-Methode, wenn das Auflösen des entsprechenden Eigenschaftsnamens (Pfad) fehlschlägt. | GridColumn | ||
columnIndex | Eigenschaft |
columnIndex:int [schreibgeschützt] | Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Die Position dieser Spalte in der Spaltenliste des Rasters oder „-1“, wenn das Raster dieser Spalte „null“ ist.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das columnIndexChanged -Ereignis ausgelöst.
Implementierung
public function get columnIndex():intdataField | Eigenschaft |
dataField:String| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Der Name des Felds oder der Eigenschaft im Datenproviderelement, das der Spalte zugeordnet ist. Für jedes GridColumn muss diese Eigenschaft oder die labelFunction-Eigenschaft festgelegt sein, damit der anzeigbare Text für den Elementrenderer berechnet werden kann. Wenn die dataField- und labelFunction-Eigenschaften eingestellt sind, werden die Daten mit labelFunction angezeigt und mit dataField sortiert.
Dieser Wert dieser Eigenschaft ist nicht notwendigerweise der String, der in der Spaltenüberschrift angezeigt wird. Diese Eigenschaft wird nur verwendet, um auf die Daten im Datenprovider zuzugreifen. Weitere Informationen finden Sie unter der headerText-Eigenschaft.
Wenn die Spalte oder ihr Raster eine labelFunction angibt, wird das dataField nicht verwendet.
Der Standardwert ist null.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das dataFieldChanged -Ereignis ausgelöst.
Implementierung
public function get dataField():String public function set dataField(value:String):voidVerwandte API-Elemente
dataTipField | Eigenschaft |
dataTipField:String| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Der Name des Felds im Datenprovider, das als Datentipp angezeigt werden soll. Wenn für showDataTips true festgelegt ist, sucht das verknüpfte Rastersteuerelement standardmäßig in jedem Datenproviderelement nach einer Eigenschaft mit dem Namen label und zeigt sie an. Wenn hingegen der Datenprovider keine label-Eigenschaft enthält, können Sie die dataTipField-Eigenschaft einstellen, um einen anderen Eigenschaftsnamen anzugeben. So können Sie beispielsweise den Wert auf „FullName“ setzen, wenn ein Benutzer eine Gruppe von Namen der Personen aus einer Datenbank ansieht.
GridColumn.dataTipField hat Vorrang vor dieser Eigenschaft.
Wenn diese Spalte oder ihr Raster einen Wert für die dataTipFunction-Eigenschaft angibt, wird die dataTipField-Eigenschaft ignoriert.
Der Standardwert ist null.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das dataTipFieldChanged -Ereignis ausgelöst.
Implementierung
public function get dataTipField():String public function set dataTipField(value:String):voidVerwandte API-Elemente
dataTipFormatter | Eigenschaft |
dataTipFormatter:IFormatter| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Legt die von der itemToDataTip()-Methode der Spalte verwendete Formatierung fest, um Datenproviderelemente in Strings zu konvertieren.
Wenn das styleParent nicht festgelegt wurde, wird es auf das Raster der Spalte eingestellt, sodass die Formatierung den locale-Stil des Rasters übernimmt.
Der Standardwert ist null.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das dataTipFormatterChanged -Ereignis ausgelöst.
Implementierung
public function get dataTipFormatter():IFormatter public function set dataTipFormatter(value:IFormatter):voidVerwandte API-Elemente
dataTipFunction | Eigenschaft |
dataTipFunction:Function| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Legt eine Rückruffunktion fest, die mit jedem Element des Datenproviders ausgeführt werden muss, um seinen Datentipp zu bestimmen. Diese Eigenschaft wird von der itemToDataTip-Methode verwendet.
Wenn für showDataTips true festgelegt ist, sucht die Spalte standardmäßig in jedem Datenproviderelement nach einer Eigenschaft mit dem Namen label und zeigt sie als Datentipp an. Allerdings haben einige Datenprovider keine label-Eigenschaft bzw. keine andere Eigenschaft, die Sie für die Anzeige von Daten in den Zeilen verwenden können.
Beispiel: Sie verfügen über einen Datenprovider, der die Felder „lastName“ und „firstName“ enthält, aber Sie möchten als Datentipp den vollen Namen anzeigen. Sie können eine Funktion für die dataTipFunction-Eigenschaft festlegen, die ein einzelnes Stringobjekt zurückgibt, das den Wert beider Felder enthält. Sie können auch die dataTipFunction-Eigenschaft verwenden, um Formatierungs- und Lokalisierungsaufgaben zu übernehmen.
Die Signatur der dataTipFunction-Funktion muss Folgendem entsprechen:
dataTipFunction(item:Object, column:GridColumn):StringDer
item-Parameter ist das Datenproviderelement für eine ganze Zeile. Der zweite Parameter ist dieses Spaltenobjekt.
Eine typische Funktion kann die firstName- und lastName-Eigenschaften eines Elements verketten oder benutzerdefinierte Formatierungen bezüglich der Eigenschaft eines Datumswerts vornehmen.
Der Standardwert ist null.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das dataTipFunctionChanged -Ereignis ausgelöst.
Implementierung
public function get dataTipFunction():Function public function set dataTipFunction(value:Function):voidVerwandte API-Elemente
editable | Eigenschaft |
editable:Boolean| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Gibt an, ob die Elemente in der Spalte bearbeitet werden können. Wenn true und die editable-Eigenschaft des verknüpften Rasters auch true ist, können die Elemente in einer Spalte bearbeitet werden. Außerdem können sie einzeln bearbeitet werden, indem auf das ausgewählte Element geklickt oder zum Element navigiert und F2 gedrückt wird.
Der Standardwert ist true.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das editableChanged -Ereignis ausgelöst.
Implementierung
public function get editable():Boolean public function set editable(value:Boolean):voidformatter | Eigenschaft |
formatter:IFormatter| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Legt die von der itemToLabel()-Methode der Spalte verwendete Formatierung fest, um Datenproviderelemente in Strings zu konvertieren.
Wenn das styleParent nicht festgelegt wurde, wird es auf das Raster der Spalte eingestellt, sodass die Formatierung den locale-Stil des Rasters übernimmt.
Der Standardwert ist null.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das formatterChanged -Ereignis ausgelöst.
Implementierung
public function get formatter():IFormatter public function set formatter(value:IFormatter):voidVerwandte API-Elemente
grid | Eigenschaft |
grid:Grid [schreibgeschützt] | Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Das mit dieser ganzen Spalte verknüpfte Grid-Objekt.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das gridChanged -Ereignis ausgelöst.
Implementierung
public function get grid():GridheaderRenderer | Eigenschaft |
headerRenderer:IFactory| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Die Klassen-Factory für die IGridItemRenderer-Klasse, die als Überschrift für diese Spalte verwendet wird. Wenn der Wert nicht festgelegt ist, definiert der columnHeaderGroup-Skinteil der DataGrid-Steuerelemente den Standardüberschriftsrenderer.
Der Standardwert ist null.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das headerRendererChanged -Ereignis ausgelöst.
Implementierung
public function get headerRenderer():IFactory public function set headerRenderer(value:IFactory):voidVerwandte API-Elemente
headerText | Eigenschaft |
headerText:String| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Der Text des Headers für diese Spalte. Standardmäßig verwendet das verknüpfte Rastersteuerelement den Wert der dataField-Eigenschaft als Text für die Überschrift.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das headerTextChanged -Ereignis ausgelöst.
Implementierung
public function get headerText():String public function set headerText(value:String):voidimeMode | Eigenschaft |
imeMode:String| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Gibt den Modus des Eingabemethodeneditors (IME) an. Mithilfe des Eingabemethodeneditors können chinesische, japanische und koreanische Schriftzeichen eingegeben werden. Flex stellt den festgelegten IME-Modus ein, wenn das Steuerelement den Fokus erhält und setzt es auf den vorherigen Wert zurück, wenn das Steuerelement den Fokus verliert.
Die flash.system.IMEConversionMode-Klasse definiert Konstanten für gültige Werte dieser Eigenschaft. Sie können auch null festlegen, um keinen IME festzulegen.
Der Standardwert ist null.
Implementierung
public function get imeMode():String public function set imeMode(value:String):voidVerwandte API-Elemente
itemEditor | Eigenschaft |
itemEditor:IFactory| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Eine Klassen-Factory für die IGridItemEditor-Klasse, die zum Bearbeiten einzelner Rasterzellen in dieser Spalte verwendet wird. Wenn diese Eigenschaft „null“ ist und der Eigentümer des Spaltenrasters ein DataGrid-Steuerelement ist, wird der Wert der itemEditor-Eigenschaft des DataGrid-Steuerelements verwendet. Wenn kein Elementeditor vom DataGrid-Steuerelement festgelegt wurde, wird die DefaultGridItemEditor-Klasse verwendet.
Der Standardelementeditor ist die DefaultGridItemEditor-Klasse, mit der Sie ein einfaches Textfeld bearbeiten können. Sie können benutzerdefinierte Elementrenderer erstellen, indem Sie eine Unterklasse der GridItemEditor-Klasse erstellen. Der benutzerdefinierte Elementeditor kann Daten in die gesamte Zeile des Rasters schreiben, um einen komplexeren Editor zu definieren.
Der Standardwert ist null.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das itemEditorChanged -Ereignis ausgelöst.
Implementierung
public function get itemEditor():IFactory public function set itemEditor(value:IFactory):voidVerwandte API-Elemente
itemRenderer | Eigenschaft |
itemRenderer:IFactory| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Die Klassen-Factory für die IGridItemRenderer-Klasse, die zum Darstellen einzelner Rasterzellen verwendet wird. Wenn nicht festgelegt, wird der Wert der itemRenderer-Eigenschaft aus dem verknüpften Rastersteuerelement verwendet.
Der Standardelementrenderer ist die DefaultGridItemRenderer-Klasse, die das Datenelement als Text darstellt. Sie können benutzerdefinierte Elementrenderer erstellen, indem Sie eine Unterklasse der GridItemRenderer-Klasse erstellen. Der benutzerdefinierte Elementrenderer kann auf die Daten von der gesamten Zeile des Rasters aus zugreifen, um eine komplexere visuelle Darstellung der Zelle zu definieren.
Der Standardwert ist der Wert der itemRenderer-Eigenschaft aus dem verknüpften Rastersteuerelement oder „null“.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das itemRendererChanged -Ereignis ausgelöst.
Implementierung
public function get itemRenderer():IFactory public function set itemRenderer(value:IFactory):voidVerwandte API-Elemente
itemRendererFunction | Eigenschaft |
itemRendererFunction:Function| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Wenn der Wert dieser Eigenschaft festgelegt wurde, muss er eine idempotente Funktion sein, die basierend auf dem Datenproviderelement und den Spaltenparametern eine Elementrenderer-IFactory zurückgibt. Durch das Festlegen eines Werts für die itemRendererFunction-Eigenschaft können mehrere Elementrenderer in dieser Spalte verwendet werden.
Die für diese itemRendererFunction-Eigenschaft festgelegte Funktion muss die folgende Signatur aufweisen:
itemRendererFunction(item:Object, column:GridColumn):IFactory
Der item-Parameter ist das Datenproviderelement für eine ganze Zeile. Der zweite Parameter ist dieses Spaltenobjekt.
Im Folgenden wird ein Beispiel für eine Elementrendererfunktion angezeigt:
function myItemRendererFunction(item:Object, column:GridColumn):IFactory
{
return (item is Array) ? myArrayItemRenderer : myItemRenderer;
}
Der Standardwert ist null.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das itemRendererFunctionChanged -Ereignis ausgelöst.
Implementierung
public function get itemRendererFunction():Function public function set itemRendererFunction(value:Function):voidlabelFunction | Eigenschaft |
labelFunction:Function| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Eine idempotente Funktion, die ein Datenproviderelement in einen spaltenspezifischen String konvertiert, mit dem die label-Eigenschaft des Elementrenderers initialisiert wird.
Mithilfe einer label-Funktion können Sie die Werte mehrerer Datenproviderelemente in einem einzigen String kombinieren. Falls angegeben, wird diese Eigenschaft von der itemToLabel()-Methode verwendet, die den Wert der label-Eigenschaft jedes Elementrenderers in dieser Spalte berechnet.
Die für diese labelFunction-Eigenschaft festgelegte Funktion muss die folgende Signatur aufweisen:
labelFunction(item:Object, column:GridColumn):String
Der item-Parameter ist das Datenproviderelement für eine ganze Zeile. Der zweite Parameter ist dieses Spaltenobjekt.
Eine typische label-Funktion kann die firstName- und lastName-Eigenschaften des Datenproviderelements verketten oder benutzerdefinierte Formatierungen bezüglich der Eigenschaft eines Datenwerts vornehmen.
Der Standardwert ist null.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das labelFunctionChanged -Ereignis ausgelöst.
Implementierung
public function get labelFunction():Function public function set labelFunction(value:Function):voidVerwandte API-Elemente
maxWidth | Eigenschaft |
maxWidth:Number| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Die maximale Breite dieser Spalte in Pixeln. Wenn festgelegt, verwendet das Layout des Rasters für die Layoutbreite der Spalte entweder die Breite des typicalItem oder die maxWidth, je nachdem, welcher Wert kleiner ist. Wenn die Größe dieser Spalte geändert werden kann, schränkt diese Eigenschaft den Benutzer dahingehend ein, wie breit er diese Spalte machen kann. Durch Festlegen dieser Eigenschaft werden die width- und minWidth-Eigenschaften nicht geändert.
Der Standardwert ist NaN.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das maxWidthChanged -Ereignis ausgelöst.
Implementierung
public function get maxWidth():Number public function set maxWidth(value:Number):voidminWidth | Eigenschaft |
minWidth:Number| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Die minimale Breite dieser Spalte in Pixeln. Wenn festgelegt, verwendet das Layout des Rasters für die Layoutbreite der Spalte entweder die Breite des typicalItem oder die minWidth, je nachdem, welcher Wert größer ist. Wenn die Größe dieser Spalte geändert werden kann, schränkt diese Eigenschaft den Benutzer dahingehend ein, wie schmal er diese Spalte machen kann. Durch Festlegen dieser Eigenschaft werden die width- und maxWidth-Eigenschaften nicht geändert.
Der Standardwert ist 20.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das minWidthChanged -Ereignis ausgelöst.
Implementierung
public function get minWidth():Number public function set minWidth(value:Number):voidrendererIsEditable | Eigenschaft |
rendererIsEditable:Boolean| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Bestimmt, ob die Steuerelemente des Elementrenderers bearbeitet werden können. Ist die Spalte bearbeitbar, erhalten die fokusfähigen Steuerelemente im Elementrenderer Tastaturfokus, wenn der Benutzer mit dem Bearbeiten des Elementrenderers beginnt.
Wenn Sie diese Eigenschaft auf true setzen, kann die Zelle bearbeitet werden, sobald der Benutzer auf eine Stelle darin klickt. Da die Zelle bearbeitet werden kann, zeigt das DataGrid den editorIndicator-Skinteil an, der oberhalb des selectionIndicator-Skinteils erscheint. Daher sieht der Benutzer keinen Indikator für Zellauswahl, bis die Bearbeitungssitzung abgeschlossen ist. Sie können eine benutzerdefinierte Skin erstellen, um den editorIndicator-Skinteil zu entfernen oder zu ändern, sodass der selectionIndicator-Skinteil angezeigt wird. Beispielsweise können Sie die alpha-Eigenschaft des editorIndicator einstellen, damit der selectionIndicator angezeigt werden kann, oder ändern Sie die Größe des editorIndicator, sodass er kleiner als die Zelle ist.
Wenn Sie diese Eigenschaft auf true setzen, sind Sie dafür verantwortlich, vom Elementrenderer erfasste Eingaben zu überprüfen und zu speichern. Wenn der Elementrenderer eine Überschreibung der IGridItemRenderer.prepare()-Methode enthält, müssen Sie sicherstellen, dass nicht gespeicherte Änderungen des Eingabefelds nicht überschrieben werden. Beispiel: rendererIsEditable ist true und der Renderer enthält ein einzelnes TextInput-Element, das den Wert von data.myDataField anzeigt. Wenn die prepare()-Methode des Renderers die text-Eigenschaft des TextInput-Steuerelements festlegt, darf die prepare()-Methode die text-Eigenschaft nicht festlegen, solange Änderungen ausstehen.
Der Standardwert ist false.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das rendererIsEditableChanged -Ereignis ausgelöst.
Implementierung
public function get rendererIsEditable():Boolean public function set rendererIsEditable(value:Boolean):voidresizable | Eigenschaft |
resizable:Boolean| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Gibt an, ob die Spaltenbreite vom Benutzer geändert werden kann. Wenn true festgelegt ist und die resizableColumns-Eigenschaft des verknüpften Rasters ebenfalls true lautet, kann der Benutzer durch Ziehen der Rasterlinien zwischen den Spaltenüberschriften die Größe der Spalte ändern.
Der Standardwert ist true.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das resizableChanged -Ereignis ausgelöst.
Implementierung
public function get resizable():Boolean public function set resizable(value:Boolean):voidshowDataTips | Eigenschaft |
showDataTips:*| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Gibt an, ob die Datentipps in der Spalte angezeigt werden. Wenn true, werden Datentipps für Text in den Zeilen angezeigt. Datentipps sind QuickInfo-Informationen, die den Text anzeigen, der zu lang für die Zeile ist.
Wenn der Wert dieser Eigenschaft nicht definiert ist (Standardeinstellung), bestimmt die showDataTips-Eigenschaft des verknüpften Rasters, ob Datentipps angezeigt werden. Wenn diese Eigenschaft festgelegt ist, wird die showDataTips-Eigenschaft des Rasters ignoriert.
Der Standardwert ist undefined.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das showDataTipsChanged -Ereignis ausgelöst.
Implementierung
public function get showDataTips():* public function set showDataTips(value:any):voidVerwandte API-Elemente
sortable | Eigenschaft |
sortable:Boolean| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Wenn true festgelegt ist, der Datenprovider des Rasters eine ICollectionView ist und die sortableColumns-Eigenschaft des zugehörigen Rasters true lautet, unterstützt diese Spalte interaktives Sortieren. Normalerweise verarbeitet die Überschrift der Spalte Mausklicks, indem die sort-Eigenschaft des Datenproviders auf ein Sort-Objekt, dessen SortField das dataField dieser Spalte ist, festgelegt wird.
Wenn der Datenprovider keine ICollectionView ist, ist diese Eigenschaft wirkungslos.
Der Standardwert ist true.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das sortableChanged -Ereignis ausgelöst.
Implementierung
public function get sortable():Boolean public function set sortable(value:Boolean):voidsortCompareFunction | Eigenschaft |
sortCompareFunction:Function| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Funktion, die beim Sortieren der Datenelemente dieser Spalte zwei Elemente vergleicht. Wenn Sie einen Wert der labelFunction-Eigenschaft angeben, geben Sie normalerweise auch eine sortCompareFunction an.
Die Signatur der sortCompareFunction muss Folgendem entsprechen:
sortCompareFunction(obj1:Object, obj2:Object, column:GridColumn):int
Die Funktion muss einen Wert zurückgeben, der auf dem Vergleich der Objekte basiert:
- -1, wenn obj1 vor obj2 in aufsteigender Folge erscheinen soll.
- 0, wenn obj1 = obj2.
- 1, wenn obj1 nach obj2 in absteigender Folge erscheinen soll.
Die Funktion kann zum Schreiben generischer Vergleichsfunktionen den Spaltenparameter verwenden.
Hinweis: Die Parameter obj1 und obj2 sind ganze Datenproviderelemente und nicht nur die Daten für das Element.
Wenn der dataProvider keine ICollectionView ist, ist diese Eigenschaft wirkungslos.
Der Standardwert ist null.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das sortCompareFunctionChanged -Ereignis ausgelöst.
Implementierung
public function get sortCompareFunction():Function public function set sortCompareFunction(value:Function):voidsortDescending | Eigenschaft |
sortDescending:Boolean| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Wenn true, wird diese Spalte in absteigender Reihenfolge sortiert. Wenn beispielsweise das dataField der Spalte einen numerischen Wert enthält, ist die erste Reihe die Reihe mit dem höchsten Wert dieser Spalte.
Beim Einstellen dieser Eigenschaft wird die Sortierung nicht gestartet, sondern nur die Sortierrichtung festgelegt. Wenn die dataProvider.refresh()-Methode aufgerufen wird, wird die Sortierung ausgeführt.
Wenn der Datenprovider keine ICollectionView ist, ist diese Eigenschaft wirkungslos.
Der Standardwert ist false.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das sortDescendingChanged -Ereignis ausgelöst.
Implementierung
public function get sortDescending():Boolean public function set sortDescending(value:Boolean):voidsortField | Eigenschaft |
sortField:SortField [schreibgeschützt] | Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Gibt ein SortField zurück, mit dem eine Sammlung nach dem dataField dieser Spalte sortiert werden kann.
Wenn die Eigenschaft sortCompareFunction definiert ist, wird die compareFunction des SortField automatisch festgelegt.
Wenn die sortCompareFunction-Eigenschaft nicht definiert ist und das dataField komplex ist, wird die Vergleichsfunktion des SortField einem Abschluss um eine Standardvergleichsfunktion zugewiesen, die das komplexe dataField verarbeitet.
Wenn die sortCompareFunction- und dataField-Eigenschaften nicht definiert sind, jedoch die labelFunction-Eigenschaft definiert ist, wird die compareFunction einem Abschluss zugewiesen, der einen einfachen Stringvergleich für die auf die Datenobjekte angewendete labelFunction vornimmt.
Implementierung
public function get sortField():SortFieldVerwandte API-Elemente
visible | Eigenschaft |
visible:Boolean| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Wenn true, wird diese Spalte angezeigt. Wenn false, wird dieser Spalte kein Raum zugeordnet; sie wird nicht in das Layout eingefügt.
Der Standardwert ist true.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das visibleChanged -Ereignis ausgelöst.
Implementierung
public function get visible():Boolean public function set visible(value:Boolean):voidwidth | Eigenschaft |
width:Number| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Die Breite dieser Spalte in Pixeln. Wenn er festgelegt wurde, ignoriert das Layout des Rasters seine typicalItem-Eigenschaft sowie die minWidth- und maxWidth-Eigenschaften dieser Spalte.
Der Standardwert ist NaN.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das widthChanged -Ereignis ausgelöst.
Implementierung
public function get width():Number public function set width(value:Number):voidGridColumn | () | Konstruktor |
itemToDataTip | () | Methode |
public function itemToDataTip(item:Object):String| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Konvertiert das angegebene Datenproviderelement in einen spaltenspezifischen Datentipp-String.
Diese Methode verwendet die Werte dataTipField und dataTipFunction. Wenn diese Eigenschaften „null“ sind, verwendet sie die entsprechenden Eigenschaften aus dem verknüpften Rastersteuerelement. Wenn auch die dataTipField-Eigenschaften im Rastersteuerelement „null“ sind, wird die dataField-Eigenschaft verwendet.
Wenn dataTipFunction und dataTipFormatter „null“ sind, ist dieser Wert der Methode der gleiche wie: item[dataTipField].toString(). Wenn dataTipFormatter angegeben ist, dann ist dieser Wert der Methode der gleiche wie: dataTipFormatter.format(item[dataTipField]). Wenn das Auflösen des dataField des Elements dazu führt, dass ein Fehler ausgegeben wird, wird ERROR_TEXT zurückgegeben.
Wenn item und dataTipFunction nicht „null“ sind, gibt diese Methode dataTipFunction(item, this) zurück. Dabei ist das zweite Argument diese GridColumn.
Parameter
item:Object — Der Wert für grid.dataProvider.getItemAt(rowIndex).
|
String — Ein spaltenspezifischer String für das angegebene Datenproviderelement oder für ERROR_TEXT.
|
itemToLabel | () | Methode |
public function itemToLabel(item:Object):String| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Konvertiert das angegebene Datenproviderelement in einen spaltenspezifischen String. Mit dieser Methode wird die label-Eigenschaft des Elementrenderers initialisiert.
Wenn labelFunction „null“ ist und dataField ein String ist, der nicht das Trennzeichen „.“ für den Feldnamen verwendet, und die Formatierung „null“ ist, entspricht diese Methode:
item[dataField].toString()
Wenn die Formatierung angegeben wurde, lautet der Wert der Methode wie folgt:
formatter.format(item[dataField])
Wenn dataField "." ist. getrennter Pfad ist, sucht diese Methode nach jedem aufeinander folgenden Pfadelement. Beispiel: Wenn ="foo.bar.baz", gibt diese Methode einen String basierend auf dem Wert item.foo.bar.baz zurück. Wenn das Auflösen des dataField des Elements zu einem Fehler führt, wird ERROR_TEXT zurückgegeben.
Wenn item und labelFunction nicht „null“ sind, gibt diese Methode labelFunction(item, this) zurück. Dabei ist das zweite Argument diese GridColumn.
Parameter
item:Object — Der Wert für grid.dataProvider.getItemAt(rowIndex).
|
String — Ein spaltenspezifischer String für das angegebene dataProvider-Element oder ERROR_TEXT.
|
itemToRenderer | () | Methode |
public function itemToRenderer(item:Object):IFactory| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Konvertiert das angegebene Datenproviderelement in eine spaltenspezifische Elementrenderer-Factory. Standardmäßig ruft diese Methode itemRendererFunction auf, falls „ungleich null“. Ansonsten wird einfach nur der Wert für die itemRenderer-Eigenschaft der Spalte zurückgegeben.
Parameter
item:Object — Der Wert für grid.dataProvider.getItemAt(rowIndex).
|
IFactory — Eine spaltenspezifische Elementrenderer-Factory für das angegebene dataProvider-Element.
|
ERROR_TEXT | Konstante |
public static const ERROR_TEXT:String = "unknown"| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Flex 4.5 |
| Laufzeitversionen: | Flash Player 10, AIR 2.5 |
Der Rückgabewert für die itemToLabel()- oder itemToDataTip()-Methode, wenn das Auflösen des entsprechenden Eigenschaftsnamens (Pfad) fehlschlägt. Der Wert dieser Konstante ist ein String mit einem Leerzeichen: " ".
Verwandte API-Elemente
<?xml version="1.0" encoding="utf-8"?>
<!--
A simple example of a DataGrid with explicitly specified columns.
The DataGrid's columns are specified by an ArrayList (an IList) and can always be accessed as such.
For example dataGrid.columns.length returns the total number of columns and
dataGrid.columns.getItemAt(index) returns the GridColumn at the specified index. The columns list
is mutable, which means that GridColumns can be added or removed at any time.
Column widths do not depend on the column's headerText, they're based on the rendered widths of
the DataGrid's typicalItem. If that's not specified, then the first data item is used. That's the
case here. Each column can specify an explicit width and by default all GridColumns are
resizable="true", which means that the column can be interactively resized by dragging the edges
between columns. Interactively resizing column widths changes the DataGrid's measuredWidth which
can be a little disconcerting if the DataGrid's width is not constrained. In this example we've
constrained the DataGrid's left and right edges which prevents changes in the DataGrid's
measuredWidth from affecting its actual width.
-->
<s:Application
xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:s="library://ns.adobe.com/flex/spark">
<s:Panel title="Spark DataGrid Control Example which demonstrates a simple DataGrid with explicitly specified columns"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<s:DataGrid id="dataGrid" left="5" right="5" top="5" bottom="5">
<s:columns>
<s:ArrayList>
<s:GridColumn dataField="key" headerText="Key"/>
<s:GridColumn dataField="name" headerText="Name"/>
<s:GridColumn dataField="price" headerText="Price"/>
<s:GridColumn dataField="call" headerText="Call"/>
</s:ArrayList>
</s:columns>
<s:ArrayCollection>
<s:DataItem key="1000" name="Abrasive" price="100.11" call="false"/>
<s:DataItem key="1001" name="Brush" price="110.01" call="true"/>
<s:DataItem key="1002" name="Clamp" price="120.02" call="false"/>
<s:DataItem key="1003" name="Drill" price="130.03" call="true"/>
<s:DataItem key="1004" name="Epoxy" price="140.04" call="false"/>
<s:DataItem key="1005" name="File" price="150.05" call="true"/>
<s:DataItem key="1006" name="Gouge" price="160.06" call="false"/>
<s:DataItem key="1007" name="Hook" price="170.07" call="true"/>
<s:DataItem key="1008" name="Ink" price="180.08" call="false"/>
<s:DataItem key="1009" name="Jack" price="190.09" call="true"/>
</s:ArrayCollection>
</s:DataGrid>
</s:Panel>
</s:Application>
<?xml version="1.0" encoding="utf-8"?>
<!--
Demonstrate the GridColumn visible property and the support for dynamically adding and removing columns.
After selecting a column it's visibility can be changed, a copy of the column can be inserted, and the column can be removed.
The DataGrid columns property is a mutable list - an IList, like ArrayList - and columns can be added or removed at any time. The difference
between an IList and an intrinsic collection type like Array or Vector is that ILists dispatch events when they're changed. That's why the
DropDownList, whose dataProvider is the list of columns, tracks the changes made with the Add/Remove buttons.
Changing a column's visibility does not change its presence or position in the columns IList but it prevents the DataGrid from displaying it.
-->
<s:Application
xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:s="library://ns.adobe.com/flex/spark">
<fx:Script>
<![CDATA[
// Insert a column to the left of specified column
private function addNewColumn(column:GridColumn):void
{
const newColumn:GridColumn = new GridColumn();
newColumn.dataField = column.dataField;
newColumn.headerText = column.headerText + "+";
dataGrid.columns.addItemAt(newColumn, column.columnIndex);
}
// Remove the specified column
private function removeColumn(column:GridColumn):void
{
dataGrid.columns.removeItemAt(column.columnIndex);
}
]]>
</fx:Script>
<s:Panel title="Spark DataGrid Control Example which demonstrates the GridColumn visible property and dynamically adding and removing columns"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<s:controlBarContent>
<s:HGroup verticalAlign="baseline">
<s:DropDownList id="ddl" prompt="Select" dataProvider="{dataGrid.columns}" labelField="headerText"/>
<s:Label text="Visible:"/>
<s:CheckBox selected="@{ddl.selectedItem.visible}" enabled="{ddl.selectedItem}"/>
<s:Button label="Add" click="addNewColumn(ddl.selectedItem)" enabled="{ddl.selectedItem}"/>
<s:Button label="Remove" click="removeColumn(ddl.selectedItem)" enabled="{ddl.selectedItem}"/>
</s:HGroup>
</s:controlBarContent>
<s:DataGrid id="dataGrid" left="5" right="5" top="5" bottom="5">
<s:columns>
<s:ArrayList>
<s:GridColumn dataField="key" headerText="Key"/>
<s:GridColumn dataField="name" headerText="Name"/>
<s:GridColumn dataField="price" headerText="Price"/>
<s:GridColumn dataField="call" headerText="Call"/>
</s:ArrayList>
</s:columns>
<s:ArrayCollection>
<s:DataItem key="1000" name="Abrasive" price="100.11" call="false"/>
<s:DataItem key="1001" name="Brush" price="110.01" call="true"/>
<s:DataItem key="1002" name="Clamp" price="120.02" call="false"/>
<s:DataItem key="1003" name="Drill" price="130.03" call="true"/>
<s:DataItem key="1004" name="Epoxy" price="140.04" call="false"/>
<s:DataItem key="1005" name="File" price="150.05" call="true"/>
<s:DataItem key="1006" name="Gouge" price="160.06" call="false"/>
<s:DataItem key="1007" name="Hook" price="170.07" call="true"/>
<s:DataItem key="1008" name="Ink" price="180.08" call="false"/>
<s:DataItem key="1009" name="Jack" price="190.09" call="true"/>
</s:ArrayCollection>
</s:DataGrid>
</s:Panel>
</s:Application>
Tue Jun 12 2018, 10:04 AM Z