blob: 6b649a4c2b55e2bb0fa6515457ceac5e70fef485 [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="CellRange,flashx.textLayout.elements.CellRange,ACTIVE,ERROR,FIT_ANY,FIT_DESCENDERS,HOVER,LINK,LOADING,LOAD_PENDING,READY,SHIFT_RETURN_AS_HARD,SHIFT_RETURN_AS_HARD_IN_LIST,SHIFT_RETURN_AS_SOFT,SIZE_PENDING,_textFlow,absoluteEnd,absoluteStart,activeCoordinates,activePosition,actualHeight,actualWidth,alignmentBaseline,anchorCoordinates,anchorPosition,backgroundAlpha,backgroundColor,baselineShift,beyondParcel,blockProgression,borderBottomColor,borderBottomPriority,borderBottomWidth,borderLeftColor,borderLeftPriority,borderLeftWidth,borderRightColor,borderRightPriority,borderRightWidth,borderTopColor,borderTopPriority,borderTopWidth,breakOpportunity,cellPadding,cellSpacing,cellSpacing,cells,cells,cffHinting,clearFloats,colIndex,colIndex,color,column,columnBreakAfter,columnBreakBefore,columnCount,columnGap,columnIndex,columnSpan,columnWidth,composedHeight,computedFormat,computedFormat,computedFormat,configuration,containerBreakAfter,containerBreakBefore,container,controller,coreStyles,cursorFunction,cursorFunction,defaultColumnFormat,defaultConfiguration,defaultLinkActiveFormat,defaultLinkActiveFormat,defaultLinkHoverFormat,defaultLinkHoverFormat,defaultLinkNormalFormat,defaultLinkNormalFormat,defaultListMarkerFormat,defaultListMarkerFormat,defaultRowFormat,defaultShiftEnterLevel,digitCase,digitWidth,direction,dominantBaseline,element,enableAccessibility,enableAccessibility,enableIME,enableIME,enableSearch,firstBaselineOffset,float,flowComposer,flowComposerClass,flowComposerClass,focusedSelectionFormat,focusedSelectionFormat,fontFamily,fontLookup,fontMapperFunction,fontSize,fontStyle,fontWeight,footerRowCount,format,formatResolver,frame,generation,graphic,hasCellDamage,hasTouchScreen,headerRowCount,height,height,height,height,height,hostFormat,href,iMaxRowDepth,id,imeMode,inactiveSelectionFormat,inactiveSelectionFormat,includeDescentInCellBounds,inlineGraphicResolverFunction,inlineGraphicResolverFunction,interactionManager,interactiveChildrenCount,isMaxHeight,justificationRule,justificationStyle,kerning,leadingModel,ligatureLevel,lineBreak,lineHeight,lineThrough,linkActiveFormat,linkHoverFormat,linkNormalFormat,linkState,listAutoPadding,listMarkerFormat,listStylePosition,listStyleType,locale,manageEnterKey,manageEnterKey,manageTabKey,manageTabKey,marginBottom,marginLeft,marginRight,marginTop,maxCellHeight,measuredHeight,measuredWidth,minCellHeight,mxmlChildren,mxmlChildren,numCells,numCells,numCells,numChildren,numColumns,numRows,overflowPolicy,overflowPolicy,paddingBottom,paddingLeft,paddingRight,paddingTop,paragraphEndIndent,paragraphSpaceAfter,paragraphSpaceBefore,paragraphStartIndent,parcelIndex,parcelIndex,parent,parentElement,parentRelativeEnd,parentRelativeStart,parent,releaseLineCreationData,releaseLineCreationData,renderingMode,resolveFontLookupFunction,resourceStringFunction,row,rowIndex,rowIndex,rowSpan,rules,scrollDragDelay,scrollDragDelay,scrollDragPixels,scrollDragPixels,scrollMouseWheelMultiplier,scrollMouseWheelMultiplier,scrollPagePercentage,scrollPagePercentage,shiftEnterLevel,shiftEnterLevel,source,status,styleName,styles,tabStops,table,table,tableBlocks,tableColumnWidth,tableWidth,table,target,terminatorSpan,text,text,textAlign,textAlignLast,textAlpha,textDecoration,textFlow,textFlowInitialFormat,textFlowInitialFormat,textFlow,textIndent,textJustify,textLength,textLength,textLength,textRotation,totalHeight,tracking,trackingLeft,trackingRight,typeName,typographicCase,unfocusedSelectionFormat,unfocusedSelectionFormat,userData,userStyles,verticalAlign,whiteSpaceCollapse,width,width,width,wordSpacing,x,x,x,x,y,y,y,addCell,addCellAt,addCellToBlock,addChild,addChild,addChildAt,addColumn,addColumnAt,addEventListener,addEventListener,addRow,addRowAt,areEqual,clearStyle,clone,clone,clone,compose,composeCells,createColumnElement,createContentElement,createRowElement,damage,decInteractiveChildrenCount,deepCopy,dispatchEvent,dispatchEvent,equalUserStyles,findCell,findChildIndexAtPosition,findLeaf,findLeaf,findNextAtomBoundary,findNextWordBoundary,findPreviousAtomBoundary,findPreviousWordBoundary,getAbsoluteStart,getBackgroundManager,getBodyRows,getCellAt,getCellAt,getCellBlock,getCells,getCells,getCellsArray,getCellsForColumn,getCellsForColumnAt,getCellsForRow,getCellsForRowArray,getCellsForRowAt,getCellsForRowAtArray,getCellsInRange,getCharAtPosition,getCharCodeAtPosition,getChildAt,getChildIndex,getColumnAt,getColumnCount,getColumnWidth,getComposedHeight,getComputedFontMetrics,getElementByID,getElementRelativeStart,getElementRelativeStart,getElementsByStyleName,getElementsByTypeName,getFirstBlock,getFirstLeaf,getFirstLeaf,getFooterHeight,getFooterRows,getHeaderHeight,getHeaderRows,getLastLeaf,getLastLeaf,getNextBlock,getNextCell,getNextCell,getNextLeaf,getNextLeaf,getNextParagraph,getNextRow,getNextSibling,getParagraph,getParagraph,getParentCellElement,getPreviousCell,getPreviousCell,getPreviousLeaf,getPreviousLeaf,getPreviousParagraph,getPreviousSibling,getResolverForNewFlow,getRow,getRowAt,getRowHeight,getRowIndex,getStyle,getTable,getTableBlocksInRange,getTableWidth,getText,getTextBlockAbsoluteStart,getTextBlockStart,getTextBlocks,getTextFlow,getTextFlow,getText,getTotalPaddingHeight,getTotalPaddingWidth,hasEventListener,hasEventListener,hasInteractiveChildren,hasMergedCells,incInteractiveChildrenCount,initialized,insertColumn,insertColumnAt,insertRow,insertRowAt,invalidate,invalidateAll,invalidateAllFormats,isDamaged,isInTable,isValid,nestedInTable,normalizeCells,normalizeColumnWidths,normalizeRange,removeAllRows,removeAllRowsWithContent,removeChild,removeChild,removeChildAt,removeColumn,removeColumnAt,removeColumnWithContent,removeColumnWithContentAt,removeEmptyTerminator,removeEventListener,removeEventListener,removeRow,removeRowAt,removeRowWithContent,removeRowWithContentAt,removed,removed,replaceChildren,replaceText,resolveExplicitFormat,resolveFormat,resolveUserFormat,setBorderColor,setBorderWidth,setColumnWidth,setRowHeight,setStyle,shallowCopy,splitAtIndex,splitAtPosition,splitAtPosition,update,updateAdornments,updateCompositionShapes,updateRange,updateRange,willTrigger,willTrigger"><title>flashx.textLayout.elements.CellRange</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 = 'CellRange - 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?flashx/textLayout/elements/CellRange.html&amp;flashx/textLayout/elements/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">CellRange</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("CellRange"); 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')">flashx.textLayout.elements</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class CellRange</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">CellRange <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> Runtime Versions :&nbsp;</b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p></p><p></p>
A read only class that describes a range of contiguous table cells. Such a range occurs when you select a
section of table cells. The range consists of the anchor point of the selection, <code>anchorPosition</code>,
and the point that is to be modified by actions, <code>activePosition</code>. As block selections are
modified and extended <code>anchorPosition</code> remains fixed and <code>activePosition</code> is modified.
The anchor position may be placed in the text before or after the active position.
<p></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="TextFlow.html" target="">TextFlow</a><br/><a href="../../../flashx/textLayout/edit/SelectionState.html" target="">SelectionState</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="#activeCoordinates" class="signatureLink">activeCoordinates</a> : <a href="../../../flashx/textLayout/elements/CellCoordinates.html">CellCoordinates</a><div class="summaryTableDescription">
Active end of the current selection, as a CellCoordinates in the TableElement.</div></td><td class="summaryTableOwnerCol">CellRange</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#anchorCoordinates" class="signatureLink">anchorCoordinates</a> : <a href="../../../flashx/textLayout/elements/CellCoordinates.html">CellCoordinates</a><div class="summaryTableDescription">
Anchor point of the current selection, as a CellCoordinates in the TableElement.</div></td><td class="summaryTableOwnerCol">CellRange</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#table" class="signatureLink">table</a> : <a href="../../../flashx/textLayout/elements/TableElement.html">TableElement</a><div class="summaryTableDescription"> The TableElement of the selection.</div></td><td class="summaryTableOwnerCol">CellRange</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="#CellRange()" class="signatureLink">CellRange</a>(table:<a href="../../../flashx/textLayout/elements/TableElement.html">TableElement</a>, anchorCoords:<a href="../../../flashx/textLayout/elements/CellCoordinates.html">CellCoordinates</a>, activeCoords:<a href="../../../flashx/textLayout/elements/CellCoordinates.html">CellCoordinates</a>)</div><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">CellRange</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#updateRange()" class="signatureLink">updateRange</a>(newAnchorCoordinates:<a href="../../../flashx/textLayout/elements/CellCoordinates.html">CellCoordinates</a>, newActiveCoordinates:<a href="../../../flashx/textLayout/elements/CellCoordinates.html">CellCoordinates</a>):Boolean</div><div class="summaryTableDescription">
Update the range with new anchor or active position values.</div></td><td class="summaryTableOwnerCol">CellRange</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="activeCoordinates"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">activeCoordinates</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>activeCoordinates:<a href="../../../flashx/textLayout/elements/CellCoordinates.html">CellCoordinates</a></code><p></p><p></p><p>
Active end of the current selection, as a CellCoordinates in the TableElement.
</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get activeCoordinates():<a href="../../../flashx/textLayout/elements/CellCoordinates.html">CellCoordinates</a></code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set activeCoordinates(value:<a href="../../../flashx/textLayout/elements/CellCoordinates.html">CellCoordinates</a>):void</code><br/></div><a name="propertyDetail"></a><a name="anchorCoordinates"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">anchorCoordinates</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>anchorCoordinates:<a href="../../../flashx/textLayout/elements/CellCoordinates.html">CellCoordinates</a></code><p></p><p></p><p>
Anchor point of the current selection, as a CellCoordinates in the TableElement.
</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get anchorCoordinates():<a href="../../../flashx/textLayout/elements/CellCoordinates.html">CellCoordinates</a></code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set anchorCoordinates(value:<a href="../../../flashx/textLayout/elements/CellCoordinates.html">CellCoordinates</a>):void</code><br/></div><a name="propertyDetail"></a><a name="table"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">table</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>table:<a href="../../../flashx/textLayout/elements/TableElement.html">TableElement</a></code><p></p><p></p><p> The TableElement of the selection.
</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get table():<a href="../../../flashx/textLayout/elements/TableElement.html">TableElement</a></code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set table(value:<a href="../../../flashx/textLayout/elements/TableElement.html">TableElement</a>):void</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="CellRange()"></a><a name="CellRange(flashx.textLayout.elements.TableElement,flashx.textLayout.elements.CellCoordinates,flashx.textLayout.elements.CellCoordinates)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">CellRange</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function CellRange(table:<a href="../../../flashx/textLayout/elements/TableElement.html">TableElement</a>, anchorCoords:<a href="../../../flashx/textLayout/elements/CellCoordinates.html">CellCoordinates</a>, activeCoords:<a href="../../../flashx/textLayout/elements/CellCoordinates.html">CellCoordinates</a>)</code><p></p><br/><br/><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">table</span>:<a href="../../../flashx/textLayout/elements/TableElement.html">TableElement</a></code></td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">anchorCoords</span>:<a href="../../../flashx/textLayout/elements/CellCoordinates.html">CellCoordinates</a></code></td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">activeCoords</span>:<a href="../../../flashx/textLayout/elements/CellCoordinates.html">CellCoordinates</a></code></td></tr></table></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="updateRange()"></a><a name="updateRange(flashx.textLayout.elements.CellCoordinates,flashx.textLayout.elements.CellCoordinates)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">updateRange</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function updateRange(newAnchorCoordinates:<a href="../../../flashx/textLayout/elements/CellCoordinates.html">CellCoordinates</a>, newActiveCoordinates:<a href="../../../flashx/textLayout/elements/CellCoordinates.html">CellCoordinates</a>):Boolean</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> Runtime Versions :&nbsp;</b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p>
Update the range with new anchor or active position values.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">newAnchorCoordinates</span>:<a href="../../../flashx/textLayout/elements/CellCoordinates.html">CellCoordinates</a></code> &mdash; the anchor index of the selection.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">newActiveCoordinates</span>:<a href="../../../flashx/textLayout/elements/CellCoordinates.html">CellCoordinates</a></code> &mdash; the active index of the selection.
</td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Boolean</code> &mdash; true if selection is changed.
</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 -->