topical media & game development

topical media & game development

[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

student-ar-fl-controls-dataGridClasses-DataGridColumn.ax

student-ar-fl-controls-dataGridClasses-DataGridColumn.ax [swf] flex


  // Copyright 2007. Adobe Systems Incorporated. All Rights Reserved.
  package fl.controls.dataGridClasses {
          import fl.controls.DataGrid;
          import fl.controls.listClasses.ICellRenderer;
          import fl.core.InvalidationType;
          import fl.controls.dataGridClasses.DataGridCellEditor;

The @ax-student-ar-fl-controls-dataGridClasses-DataGridColumn class describes a column in a DataGrid component. There is one @ax-student-ar-fl-controls-dataGridClasses-DataGridColumn object for every column that could be displayed on the screen, even for columns that are currently hidden or off-screen. The data provider items that belong to a DataGrid component can contain properties that are not displayed; such properties do not require a @ax-student-ar-fl-controls-dataGridClasses-DataGridColumn. You can specify the kind of component that displays the data for a @ax-student-ar-fl-controls-dataGridClasses-DataGridColumn. The characteristics that can be specified include the text that appears in the column header and whether the column can be edited, sorted, or resized.
see: fl.controls.DataGrid @includeExample examples/@fileExample.as @langversion 3.0 @playerversion Flash 9.0.28.0


  
          public class @ax-student-ar-fl-controls-dataGridClasses-DataGridColumn        {

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  private var _columnName:String;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  private var _headerText:String;

@private @langversion 3.0 @playerversion Flash 9.0.28.0 @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  private var _minWidth:Number = 20;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  private var _width:Number = 100;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  private var _visible:Boolean = true;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  private var _cellRenderer:Object;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  private var _headerRenderer:Object;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  private var _labelFunction:Function;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  private var _sortCompareFunction:Function;

@private Storage for the <code>imeMode</code> property.


  
                  private var _imeMode:String;

@private (internal) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public var owner:DataGrid; // mx_internal

@private (internal) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public var colNum:Number; // mx_internal

@private (internal) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public var explicitWidth:Number; // mx_internal

Indicates whether the user can click on the header of the current column to sort the data provider. A value of <code>true</code> indicates that the column can be sorted by clicking on its header; a value of <code>false</code> indicates that it cannot be sorted by clicking on its header. @default true @includeExample examples/@ax-student-ar-fl-controls-dataGridClasses-DataGridColumn.sortable.1.as -noswf @includeExample examples/@ax-student-ar-fl-controls-dataGridClasses-DataGridColumn.sortable.2.as -noswf @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public var sortable:Boolean = true;

Indicates whether the user is allowed to change the width of the column. A value of <code>true</code> indicates that the user can change the column width; a value of <code>false</code> indicates that the user cannot change the column width. @default true @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public var resizable:Boolean = true;

Indicates whether the items in the column can be edited. A value of <code>true</code> indicates that the column items can be edited; a value of <code>false</code> indicates that they cannot be edited. If this property is set to <code>true</code> and the <code>editable</code> property of the DataGrid is also <code>true</code>, the items in a column are editable and can be individually edited by clicking an item or by navigating to the item by using the Tab and arrow keys. @default true @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public var editable:Boolean = true;

Indicates the class of the instances of the item editor to use for the column, when it is editable. The type of this property can be Class, Sprite or String. If the property type is String, the string value must be a fully qualified class name. @default "fl.controls.dataGridClasses.DataGridCellEditor" @includeExample examples/@ax-student-ar-fl-controls-dataGridClasses-DataGridColumn.itemEditor.1.as -noswf @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public var itemEditor:Object = "fl.controls.dataGridClasses.DataGridCellEditor";

Identifies the name of the property of the item editor that contains the new data for the list item. For example, the default <code>itemEditor</code> is TextInput, so the default value of the <code>editorDataField</code> property is <code>"text"</code>. This value specifies the <code>text</code> property of the TextInput component. @default "text" @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public var editorDataField:String = "text";

Identifies the name of the field or property in the data provider item that is associated with the column. @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public var dataField:String;

Indicates whether the @ax-student-ar-fl-controls-dataGridClasses-DataGridColumn is to be sorted in ascending or descending order. A value of <code>true</code> indicates that the @ax-student-ar-fl-controls-dataGridClasses-DataGridColumn is sorted in descending order; a value of <code>false</code> indicates that the DataGridColum is sorted in ascending order. @default false @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public var sortDescending:Boolean = false;

One or more defined constants, identified by name or number and separated by the bitwise OR (|) operator. These constants are used to specify the sort operation. @default 0 @includeExample examples/@ax-student-ar-fl-controls-dataGridClasses-DataGridColumn.sortOptions.1.as -noswf
see: Array#sort() @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public var sortOptions:uint = 0;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  private var forceImport:DataGridCellEditor;

Creates a new @ax-student-ar-fl-controls-dataGridClasses-DataGridColumn instance.
parameter: columnName The column name to display in the column header. If no name is specified, the <code>dataField</code> value is used. @default null
see: @ax-student-ar-fl-controls-dataGridClasses-DataGridColumn#headerText @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function @ax-student-ar-fl-controls-dataGridClasses-DataGridColumn(columnName:String = null) {
                          if (columnName) {
                                  dataField = columnName;
                                  headerText = columnName;
                          }
                  }

The class that is used to render the items in this column. The type of this property can be Class, Sprite or String. If the property type is String, the String value must be a fully qualified class name. @default null @includeExample examples/@ax-student-ar-fl-controls-dataGridClasses-DataGridColumn.cellRenderer.1.as -noswf
see: #headerRenderer @ax-student-ar-fl-controls-dataGridClasses-DataGridColumn.headerRenderer @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function get cellRenderer():Object {
                          return _cellRenderer;
                  }

@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function set cellRenderer(value:Object):void {
                          _cellRenderer = value;
                          if (owner) {
                                  owner.invalidate(InvalidationType.DATA);
                          }
                  }

The class that is used to render the header of this column. The type of this property can be Class, Sprite or String. If the property type is String, the string value must be a fully qualified class name.
@default null
see: #cellRenderer @ax-student-ar-fl-controls-dataGridClasses-DataGridColumn.cellRenderer
see: HeaderRenderer @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function get headerRenderer():Object {
                          return _headerRenderer;
                  }

@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function set headerRenderer(value:Object):void {
                          _headerRenderer = value;
                          if (owner) {
                                  owner.invalidate(InvalidationType.DATA);
                          }
                  }

The column name to be displayed in the column header. By default, the DataGrid component uses the value of the <code>dataField</code> property as the column name. @includeExample examples/@ax-student-ar-fl-controls-dataGridClasses-DataGridColumn.headerText.1.as -noswf @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function get headerText():String {
                          return (_headerText != null) ? _headerText : dataField;
                  }

@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function set headerText(value:String):void {
                          _headerText = value;
                          if (owner) {
                                  owner.invalidate(InvalidationType.DATA);
                          }
                  }

The mode of the input method editor (IME). The IME enables users to enter text in Chinese, Japanese, and Korean. The flash.system.IMEConversionMode class defines constants to be used as the valid values for this property. If this property is <code>null</code>, the mode of the IME is set to the value of the <code>imeMode</code> property of the DataGrid component. @default null
see: flash.system.IMEConversionMode @langversion 3.0 @playerversion Flash 9.0.28.0 @internal [kenos] The IME probably allows users of a QWERTY keyboard to enter characters from the Chinese, Japanese, and Korean *character sets*. You can render Japanese words in Roman letters, if you like, on a QWERTY keyboard, so the existing description here is probably not quite right.


  
                  public function get imeMode():String {
                          return _imeMode;
                  }

@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function set imeMode(value:String):void {
                          _imeMode = value;
                  }

A function that determines the text to be displayed in this column. By default, the column displays the text for the data field that matches the column name. However, a column can also be used to display the text of more than one data field, or to display content that is not in the proper format. This can be done by using the <code>labelFunction</code> property to specify a callback function. If both the <code>labelFunction</code> and <code>labelField</code> properties are defined, the <code>labelFunction</code> takes precedence. @default null @includeExample examples/@ax-student-ar-fl-controls-dataGridClasses-DataGridColumn.labelFunction.1.as -noswf @includeExample examples/@ax-student-ar-fl-controls-dataGridClasses-DataGridColumn.sortCompareFunction.1.as -noswf @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function get labelFunction():Function {
                          return _labelFunction;
                  }

@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function set labelFunction(value:Function):void {
                          if (_labelFunction == value) { return; }
                          _labelFunction = value;
                          if (owner) {
                                  owner.invalidate(InvalidationType.DATA);
                          }
                  }

The minimum width of the column, in pixels. @default 20 @includeExample examples/@ax-student-ar-fl-controls-dataGridClasses-DataGridColumn.minWidth.1.as -noswf
see: #width @ax-student-ar-fl-controls-dataGridClasses-DataGridColumn.width @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function get minWidth():Number {
                          return _minWidth;
                  }

@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function set minWidth(value:Number):void {
                          _minWidth = value;
                          if (_width < value) {
                                  _width = value;
                          }
                          if (owner) {
                                  owner.invalidate(InvalidationType.SIZE);
                          }
                  }

A callback function that is called when sorting the data in the column. If this property is not specified, the data is sorted by string or number, depending on the <code>sortOptions</code> property. When specified, the <code>sortCompareFunction</code> property allows you to create your own custom sorting method for the current data grid column. @default null
see: #sortOptions @includeExample examples/@ax-student-ar-fl-controls-dataGridClasses-DataGridColumn.sortCompareFunction.1.as -noswf @langversion 3.0 @playerversion Flash 9.0.28.0 @internal [kenos] More information here on what the callback is used to do? Sounds like it supplants the sortOptions but is it used to specify any particular type of sort?


  
                  public function get sortCompareFunction():Function {
                          return _sortCompareFunction;
                  }

@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function set sortCompareFunction(value:Function):void {
                          _sortCompareFunction = value;
                  }

Indicates whether the column is visible. A value of <code>true</code> indicates that the column is visible; a value of <code>false</code> indicates that the column is invisible. @includeExample examples/@ax-student-ar-fl-controls-dataGridClasses-DataGridColumn.visible.1.as -noswf @default true @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function get visible():Boolean {
                          return _visible;
                  }

@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function set visible(value:Boolean):void {
                          if (_visible != value) {
                                  _visible = value;
                                  if (owner) {
                                          owner.invalidate(InvalidationType.SIZE);
                                  }
                          }
                  }

The width of the column, in pixels. @default 100
see: #minWidth @ax-student-ar-fl-controls-dataGridClasses-DataGridColumn.minWidth @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function get width():Number {
                          return _width;
                  }

@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function set width(value:Number):void {
                          // remove any queued equal spacing commands
                          explicitWidth = value;
                          if (owner != null) {
                                  // if we aren't resizing as part of grid layout, resize it's column
                                  var oldVal:Boolean = resizable;
                                  // anchor this column to not accept any overflow width for accurate sizing
                                  resizable = false;
                                  owner.resizeColumn(colNum, value);
                                  resizable = oldVal;
                          } else {
                                  // otherwise, just store the size
                                  _width = value;
                          }
                  }

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function setWidth(value:Number):void {
                          _width = value;
                  }
  
                  //--------------------------------------------------------------------------
                  //  Methods
                  //--------------------------------------------------------------------------

Returns the string that the item renderer displays for the given data object. If the @ax-student-ar-fl-controls-dataGridClasses-DataGridColumn or its DataGrid component has a non-null <code>labelFunction</code> property, it applies the function to the data object. Otherwise, the method extracts the contents of the field that is specified by the <code>dataField</code> property, or gets the string value of the data object. If the method cannot convert the parameter to a string, it returns a single space.
parameter: data The Object to be rendered.
returns: Displayable string based on the specified data object. @internal dg.addEventListener("itemClick", itemClickHandler); function itemClickHandler(evt:ListEvent):void { var col:@ax-student-ar-fl-controls-dataGridClasses-DataGridColumn = dg.getColumnAt(evt.columnIndex); trace(col.itemToLabel(evt.item)); } @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function itemToLabel(data:Object):String {
                          if (!data) {
                                  return " ";
                          }
                          if (labelFunction != null) {
                                  return labelFunction(data);
                          }
                          if (owner.labelFunction != null) {
                                  return owner.labelFunction(data, this);
                          }
                          if (typeof(data) == "object" || typeof(data) == "xml") {
                                  try {
                                          data = data[dataField];
                                  } catch(e:Error) {
                                          data = null;
                                  }
                          }
                          if (data is String) {
                                  return String(data);
                          }
                          try {
                                  return data.toString();
                          } catch(e:Error) {
                          }
                          return " ";
                  }

Returns a string representation of the @ax-student-ar-fl-controls-dataGridClasses-DataGridColumn object.
returns: "[object @ax-student-ar-fl-controls-dataGridClasses-DataGridColumn]" @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function toString():String {
                          return "[object @ax-student-ar-fl-controls-dataGridClasses-DataGridColumn]";
                  }
          }
  }

[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

You may not copy or print any of this material without explicit permission of the author or the publisher. In case of other copyright issues, contact the author.