blob: 40064ff79829a5c7c296d0d059f1e76bea2dee47 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!-- saved from url=(0014)about:internet --><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><link rel="stylesheet" href="../../../style.css" type="text/css" media="screen"><link rel="stylesheet" href="../../../print.css" type="text/css" media="print"><link rel="stylesheet" href="../../../override.css" type="text/css"><meta name="keywords" content="CellRegion,spark.components.gridClasses.CellRegion,CELL,DOUBLE_CLICK,ERROR_TEXT,GRID,MULTIPLE_CELLS,MULTIPLE_ROWS,NONE,NONE,ROW,SINGLE_CELL,SINGLE_CLICK,SINGLE_CLICK_ON_SELECTED_CELL,SINGLE_ROW,column,column,column,column,columnCount,columnIndex,columnIndex,columnIndex,columnIndex,columnIndex,columnIndex,columnIndex,column,comboBox,data,data,dataField,dataGrid,dataGrid,dataGrid,dataGrid,dataProvider,dataTipField,dataTipFormatter,dataTipFunction,down,down,dragging,dragging,editable,editedItemPosition,editedItemRenderer,editorActivationMouseEvent,editorColumnIndex,editorRowIndex,enableIME,formatter,grid,grid,grid,grid,gridColumnHeaderGroup,gridHeaderViewLayout,gridViewLayout,headerRenderer,headerText,hovered,hovered,imeMode,imeMode,itemEditor,itemEditorInstance,itemRenderer,itemRenderer,itemRendererFunction,label,label,labelDisplay,labelFunction,maxWidth,minWidth,percentWidth,rendererIsEditable,resizable,rowCount,rowIndex,rowIndex,rowIndex,rowIndex,rowIndex,rowIndex,selected,selected,showDataTips,showsCaret,showsCaret,sortCompareFunction,sortCompareType,sortDescending,sortField,sortable,textArea,value,visible,width"><title>spark.components.gridClasses.CellRegion</title></head><body><script language="javascript" type="text/javascript" src="../../../asdoc.js"></script><script language="javascript" type="text/javascript" src="../../../help.js"></script><script language="javascript" type="text/javascript" src="../../../cookies.js"></script><script language="javascript" type="text/javascript"><!--
asdocTitle = 'CellRegion - ApacheFlex API Reference';
var baseRef = '../../../';
window.onload = configPage;
--></script>
<script type="text/javascript">
scrollToNameAnchor();
</script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">Apache Flex 4.16.1 API Reference </td><td class="titleTableTopNav" align="right"><a href="../../../package-summary.html" onclick="loadClassListFrame('../../../all-classes.html')">All Packages</a>&nbsp;|&nbsp;<a href="../../../class-summary.html" onclick="loadClassListFrame('../../../all-classes.html')">All Classes</a>&nbsp;|&nbsp;<a href="../../../all-index-A.html" onclick="loadClassListFrame('../../../index-list.html')">Index</a>&nbsp;|&nbsp;<a id="framesLink1" href="../../../index.html?spark/components/gridClasses/CellRegion.html&amp;spark/components/gridClasses/class-list.html">Frames</a><a id="noFramesLink1" style="display:none" href="" onclick="parent.location=document.location"> No Frames </a></td><td class="titleTableLogo" align="right" rowspan="3"><img src="../../../images/logo.jpg" class="logoImage" alt="AdobeLogo" title="AdobeLogo"></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">CellRegion</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td></tr><tr class="titleTableRow3"><td colspan="3">&nbsp;</td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("CellRegion"); titleBar_setSubNav(false,true,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);}
-->
</script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">spark.components.gridClasses</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class CellRegion</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">CellRegion <img src="../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> Object</td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 10, AIR 2.5</td></tr></table><p></p><p></p><p></p><p></p>
The CellRegion class defines a data structure
used by the Spark data grid classes to represent a rectangular region of
cells in the control.
The origin of the region is specified by the
<code>rowIndex</code> and <code>columnIndex</code> properties.
The extent of the region is specified by the
<code>rowCount</code> and the <code>columnCount</code> properties.
<p></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="../../../spark/components/DataGrid.html" target="">spark.components.DataGrid</a><br/><a href="../../../spark/components/Grid.html" target="">spark.components.Grid</a></div><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProperty"><tr><th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#columnCount" class="signatureLink">columnCount</a> : int<div class="summaryTableDescription">
The number of columns in the cell region.</div></td><td class="summaryTableOwnerCol">CellRegion</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#columnIndex" class="signatureLink">columnIndex</a> : int<div class="summaryTableDescription">
The 0-based column index of the origin of the cell region.</div></td><td class="summaryTableOwnerCol">CellRegion</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#rowCount" class="signatureLink">rowCount</a> : int<div class="summaryTableDescription">
The number of rows in the cell region.</div></td><td class="summaryTableOwnerCol">CellRegion</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#rowIndex" class="signatureLink">rowIndex</a> : int<div class="summaryTableDescription">
The 0-based row index of the origin of the cell region.</div></td><td class="summaryTableOwnerCol">CellRegion</td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#CellRegion()" class="signatureLink">CellRegion</a>(rowIndex:int = -1, columnIndex:int = -1, rowCount:int = 0, columnCount:int = 0)</div><div class="summaryTableDescription">
Constructor.</div></td><td class="summaryTableOwnerCol">CellRegion</td></tr></table></div><script language="javascript" type="text/javascript"><!--
showHideInherited();
--></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</div><a name="propertyDetail"></a><a name="columnCount"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">columnCount</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>columnCount:int</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 10, AIR 2.5</td></tr></table><p></p><p></p><p>
The number of columns in the cell region.
</p><p> The default value is <code>0</code>.</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get columnCount():int</code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set columnCount(value:int):void</code><br/></div><a name="propertyDetail"></a><a name="columnIndex"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">columnIndex</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>columnIndex:int</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 10, AIR 2.5</td></tr></table><p></p><p></p><p>
The 0-based column index of the origin of the cell region.
A value of -1 indicates that the value is not set.
</p><p> The default value is <code>-1</code>.</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get columnIndex():int</code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set columnIndex(value:int):void</code><br/></div><a name="propertyDetail"></a><a name="rowCount"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">rowCount</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>rowCount:int</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 10, AIR 2.5</td></tr></table><p></p><p></p><p>
The number of rows in the cell region.
</p><p> The default value is <code>0</code>.</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get rowCount():int</code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set rowCount(value:int):void</code><br/></div><a name="propertyDetail"></a><a name="rowIndex"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">rowIndex</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>rowIndex:int</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 10, AIR 2.5</td></tr></table><p></p><p></p><p>
The 0-based row index of the origin of the cell region.
A value of -1 indicates that the value is not set.
</p><p> The default value is <code>-1</code>.</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get rowIndex():int</code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set rowIndex(value:int):void</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="CellRegion()"></a><a name="CellRegion(int,int,int,int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">CellRegion</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function CellRegion(rowIndex:int = -1, columnIndex:int = -1, rowCount:int = 0, columnCount:int = 0)</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 10, AIR 2.5</td></tr></table><p></p><p>
Constructor.
</p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">rowIndex</span>:int</code> (default = <code>-1</code>)<code></code> &mdash; The 0-based row index of the origin cell.
A value of -1 indicates that the value is not set.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">columnIndex</span>:int</code> (default = <code>-1</code>)<code></code> &mdash; The 0-based column index of the origin cell.
A value of -1 indicates that the value is not set.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">rowCount</span>:int</code> (default = <code>0</code>)<code></code> &mdash; The number of rows in the cell region.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">columnCount</span>:int</code> (default = <code>0</code>)<code></code> &mdash; The number of columns in the cell region.
</td></tr></table></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>The Apache Software Foundation</footer><br/>Wed Nov 15 2017, 09:50 AM +01:00 </center></div></body></html><!--The Apache Software Foundation<br/>Wed Nov 15 2017, 09:50 AM +01:00 -->