blob: ea8fc549f6596f5cadffeb39f1b96fd2418d7fc5 [file]
<!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="DragSource,mx.core.DragSource,ABSOLUTE,ALL,AUTO,AUTO,AUTO,BINDING,CURRENT,CURRENT_VERSION,CURSOR_MANAGEMENT,DEFAULT,DEFAULT,DEFAULT_HANDLER,DEFAULT_MAX_HEIGHT,DEFAULT_MAX_WIDTH,DEFAULT_MEASURED_HEIGHT,DEFAULT_MEASURED_MIN_HEIGHT,DEFAULT_MEASURED_MIN_WIDTH,DEFAULT_MEASURED_WIDTH,DPI_120,DPI_160,DPI_240,DPI_320,DPI_480,DPI_640,EFFECT,EMPTY,HORIZONTAL,LTR,MOUSE,MXMLDescriptor,MXMLProperties,NONE,OFF,OFF,ON,ON,PARENT,QUEUED,RTL,TOP_LEVEL,TOUCH,VERSION_2_0,VERSION_2_0_1,VERSION_3_0,VERSION_4_0,VERSION_4_10,VERSION_4_11,VERSION_4_12,VERSION_4_13,VERSION_4_14,VERSION_4_15,VERSION_4_16,VERSION_4_16_1,VERSION_4_5,VERSION_4_6,VERSION_4_8,VERSION_4_9,VERSION_ALREADY_READ,VERSION_ALREADY_SET,VERTICAL,accessibilityDescription,accessibilityEnabled,accessibilityName,accessibilityProperties,accessibilityShortcut,activeEffects,actualCreationPolicy,allowDomainsInNewRSLs,allowInsecureDomainsInNewRSLs,alpha,alpha,alpha,alwaysInFront,alwaysInFront,alwaysShowSelection,alwaysShowSelection,antiAliasType,antiAliasType,antiAliasType,application,applicationDomainTarget,applicationID,autoExit,autoLayout,autoSize,autoSize,automationDelegate,automationDelegate,automationDelegate,automationEnabled,automationEnabled,automationEnabled,automationName,automationName,automationName,automationOwner,automationOwner,automationOwner,automationParent,automationParent,automationParent,automationTabularData,automationValue,automationValue,automationValue,automationVisible,automationVisible,automationVisible,background,background,backgroundColor,backgroundColor,backgroundFrameRate,backgroundImageBounds,baseline,baseline,baselinePosition,baselinePosition,baselinePosition,baselinePosition,baselinePosition,blendMode,border,border,border,borderColor,borderColor,borderMetrics,borderMetrics,borderMetrics,borderMetrics,borderMetrics,bottom,bottom,bottom,bottomScrollV,bottomScrollV,boxLayoutClass,buttonMode,cacheAsBitmap,cacheHeuristic,cacheHeuristic,cachePolicy,cachePolicy,canvasLayoutClass,caretIndex,caretIndex,childAllowsParent,childDescriptors,childDescriptors,className,className,className,clipContent,closed,closed,compatibilityErrorFunction,compatibilityVersion,compatibilityVersionString,computedMatrix,computedMatrix3D,condenseWhite,condenseWhite,constraintColumns,constraintRows,container,container,contentMouseX,contentMouseX,contentMouseY,contentMouseY,controlBar,controlBar,count,count,creatingContentPane,creatingContentPane,creationIndex,creationPolicy,creationPolicy,currentCSSState,currentIndex,currentIndex,currentItem,currentItem,currentState,currentState,cursorManager,data,data,dataProvider,dataProvider,defaultButton,defaultButton,defaultTextFormat,defaultTextFormat,deferredContentCreated,deferredContentCreated,depth,depth,descriptor,descriptor,designLayer,designLayer,digest,direction,direction,displayAsPassword,displayAsPassword,dockIconMenu,document,document,document,document,document,doubleClickEnabled,doubleClickEnabled,doubleClickEnabled,dropTarget,editable,effectiveAlpha,effectiveVisibility,effects,embedFonts,embedFonts,emphasized,enableIME,enableIME,enableIME,enableIME,enabled,enabled,enabled,enabled,errorString,events,explicitHeight,explicitHeight,explicitHeight,explicitHeight,explicitMaxHeight,explicitMaxHeight,explicitMaxHeight,explicitMaxHeight,explicitMaxWidth,explicitMaxWidth,explicitMaxWidth,explicitMaxWidth,explicitMinHeight,explicitMinHeight,explicitMinHeight,explicitMinHeight,explicitMinWidth,explicitMinWidth,explicitMinWidth,explicitMinWidth,explicitWidth,explicitWidth,explicitWidth,explicitWidth,filters,flexContextMenu,focusEnabled,focusEnabled,focusManager,focusManager,focusPane,focusPane,focusPane,focusPane,focusRect,focusRect,fontContext,fontContext,formats,frameRate,generator,graphics,gridFitType,gridFitType,gridFitType,hasBackgroundImage,hasComplexLayoutMatrix,hasFocusableChildren,hasFocusableChildren,hasLayoutMatrix3D,hasLayoutMatrix3D,hashType,height,height,height,historyManagementEnabled,hitArea,horizontalCenter,horizontalCenter,horizontalLineScrollSize,horizontalPageScrollSize,horizontalScrollBar,horizontalScrollBar,horizontalScrollPolicy,horizontalScrollPolicy,horizontalScrollPosition,horizontalScrollPosition,horizontalScrollPosition,horizontalScrollPosition,htmlText,htmlText,icon,icon,id,id,id,id,ignorePadding,ignorePadding,ignorePadding,imeMode,imeMode,imeMode,imeMode,includeInLayout,includeInLayout,includeInLayout,includeInLayout,includeInLayout,inheritingStyles,inheritingStyles,inheritingStyles,inheritingStyles,initialHeight,initialWidth,initialized,initialized,initialized,instanceIndex,instanceIndices,instanceIndices,is3D,is3D,is3D,isDocument,isDocument,isPopUp,isPopUp,isPopUp,isPopUp,isSigned,label,label,label,layout,layoutDirection,layoutDirection,layoutDirection,layoutIs3D,layoutMatrix,layoutMatrix3D,layoutMatrix3D,layoutRotationX,layoutRotationY,layoutRotationZ,layoutScaleX,layoutScaleY,layoutScaleZ,layoutWidth,layoutX,layoutY,layoutZ,left,left,left,length,length,liveScrolling,loadForCompatibility,loaderInfo,locale,locale,maintainProjectionCenter,mask,maskShape,maxChars,maxChars,maxChars,maxHeight,maxHeight,maxHeight,maxHeight,maxHorizontalScrollPosition,maxHorizontalScrollPosition,maxScrollH,maxScrollH,maxScrollV,maxScrollV,maxVerticalScrollPosition,maxVerticalScrollPosition,maxWidth,maxWidth,maxWidth,maxWidth,maximizable,maximizable,maximizable,measuredHeight,measuredHeight,measuredHeight,measuredHeight,measuredHeight,measuredHeight,measuredHeight,measuredHeight,measuredHeight,measuredMinHeight,measuredMinHeight,measuredMinHeight,measuredMinHeight,measuredMinWidth,measuredMinWidth,measuredMinWidth,measuredMinWidth,measuredWidth,measuredWidth,measuredWidth,measuredWidth,measuredWidth,measuredWidth,measuredWidth,measuredWidth,measuredWidth,menu,menu,minHeight,minHeight,minHeight,minHeight,minWidth,minWidth,minWidth,minWidth,minimizable,minimizable,minimizable,mirror,moduleFactory,moduleFactory,moduleFactory,moduleFactory,moduleFactory,moduleFactory,mouseChildren,mouseChildren,mouseEnabled,mouseEnabled,mouseEnabled,mouseFocusEnabled,mouseFocusEnabled,mouseWheelEnabled,mouseWheelEnabled,mouseX,mouseY,movieClipData,multiline,multiline,name,nativeApplication,nativeWindow,nativeWindow,nativeWindow,nestLevel,nestLevel,nestLevel,nestLevel,nonInheritingStyles,nonInheritingStyles,nonInheritingStyles,nonInheritingStyles,nonZeroTextHeight,nonZeroTextHeight,nonZeroTextHeight,numAutomationChildren,numChildren,numChildren,numChildren,numElements,numElements,numLayers,numLines,numLines,opaqueBackground,owner,owner,owner,owner,owner,pageTitle,parameters,parent,parent,parent,parent,parent,parent,parentAllowsChild,parentApplication,parentBridge,parentBridge,parentDocument,parentDrawsFocus,percentHeight,percentHeight,percentHeight,percentHeight,percentHeight,percentWidth,percentWidth,percentWidth,percentWidth,percentWidth,policyFileURL,postLayoutTransformOffsets,postLayoutTransformOffsets,preloadedRSLs,preloader,preloaderChromeColor,processedDescriptors,processedDescriptors,processedDescriptors,properties,properties,propertiesFactory,rawChildren,rawChildren,recycleChildren,recycleChildren,repeater,repeaterIndex,repeaterIndices,repeaterIndices,repeaters,repeaters,resetHistory,resizable,resizable,resizable,resourceManager,restrict,restrict,restrict,right,right,right,root,rotation,rotation,rotationX,rotationY,rotationZ,rslURL,runtimeDPI,scale9Grid,scaleX,scaleX,scaleY,scaleY,scaleZ,screen,screen,scriptRecursionLimit,scriptTimeLimit,scrollAreaChanged,scrollH,scrollH,scrollRect,scrollTipFunction,scrollV,scrollV,selectable,selectable,selectable,selectedIndex,selectionActivePosition,selectionAnchorPosition,selectionBeginIndex,selectionBeginIndex,selectionEndIndex,selectionEndIndex,sharpness,sharpness,sharpness,showGripper,showGripper,showInAutomationHierarchy,showScrollTips,showStatusBar,showStatusBar,showTitleBar,showTitleBar,soundTransform,stage,startingIndex,startingIndex,states,states,status,status,status,statusBar,statusBar,statusBarFactory,statusBarFactory,statusBarStyleFilters,statusBarStyleFilters,stretchX,stretchY,styleDeclaration,styleManager,styleName,styleName,styleName,styleParent,styleSheet,styleSheet,stylesFactory,swfBridge,systemChrome,systemChrome,systemChrome,systemManager,systemManager,systemManager,systemManager,systemTrayIconMenu,tabChildren,tabEnabled,tabEnabled,tabFocusEnabled,tabFocusEnabled,tabIndex,tabIndex,text,text,text,text,textColor,textColor,textHeight,textHeight,textSnapshot,textWidth,textWidth,thickness,thickness,thickness,title,title,title,titleBar,titleBar,titleBarFactory,titleBarFactory,titleBarStyleFilters,titleBarStyleFilters,titleIcon,titleIcon,titleIcon,toolTip,toolTip,toolTip,top,top,top,topLevelApplication,transform,transform,transformX,transformX,transformY,transformY,transformZ,transformZ,transitions,transitions,transparent,transparent,transparent,tweeningProperties,tweeningProperties,tweeningProperties,tweeningProperties,type,type,type,type,type,type,uid,uid,unscaledHeight,unscaledWidth,updateCompletePendingFlag,updateCompletePendingFlag,updateCompletePendingFlag,url,useFTE,useHandCursor,useNativeDragManager,usePreloader,useRichTextClipboard,useRichTextClipboard,validationSubField,verifyDigest,verticalCenter,verticalCenter,verticalLineScrollSize,verticalPageScrollSize,verticalScrollBar,verticalScrollBar,verticalScrollPolicy,verticalScrollPolicy,verticalScrollPosition,verticalScrollPosition,verticalScrollPosition,viewMetrics,viewMetrics,viewMetrics,viewMetricsAndPadding,viewSourceURL,visible,visible,visible,visible,visible,width,width,width,wordWrap,wordWrap,x,x,x,y,y,y,z,activate,activate,addChild,addChild,addChild,addChildAt,addChildAt,addChildAt,addChildBridge,addChildBridge,addData,addElement,addElement,addElementAt,addElementAt,addHandler,addLayer,addMXMLChildren,addPreloadedRSL,addStyleClient,addToCreationQueue,adjustFocusRect,allowDomain,allowInsecureDomain,appendText,appendText,applyComputedMatrix,areInaccessibleObjectsUnderPoint,assignFocus,attachOverlay,attachOverlay,callInContext,callLater,callLater,canSkipMeasurement,childrenCreated,clearStyle,clone,close,close,close,commitProperties,contains,contains,containsBridge,containsBridge,contentToGlobal,contentToGlobal,contentToLocal,contentToLocal,create,createAutomationIDPart,createAutomationIDPartWithRequiredProperties,createBorder,createBorder,createChildren,createChildren,createComponentFromDescriptor,createComponentsFromDescriptors,createDeferredContent,createDeferredContent,createInFontContext,createInModuleContext,createReferenceOnParentDocument,createReferenceOnParentDocument,dataForFormat,deleteReferenceOnParentDocument,deleteReferenceOnParentDocument,determineTextFormatFromStyles,dispatchEvent,dispatchPropertyChangeEvent,drawFocus,drawFocus,drawRoundRect,effectFinished,effectStarted,endEffectsStarted,executeBindings,executeBindings,executeBindings,executeChildBindings,executeChildBindings,executeChildBindings,exit,finishPrint,focusInHandler,focusOutHandler,generateMXMLArray,generateMXMLAttributes,generateMXMLInstances,generateMXMLObject,generateMXMLVector,getAutomationChildAt,getAutomationChildren,getBounds,getBoundsXAtSize,getBoundsXAtSize,getBoundsYAtSize,getBoundsYAtSize,getCharBoundaries,getCharBoundaries,getCharIndexAtPoint,getCharIndexAtPoint,getChildAt,getChildAt,getChildAt,getChildBridgeProvider,getChildBridgeProvider,getChildBridges,getChildBridges,getChildByName,getChildByName,getChildByName,getChildIndex,getChildIndex,getChildIndex,getChildren,getClassStyleDeclarations,getConstraintValue,getConstraintValue,getElementAt,getElementAt,getElementIndex,getElementIndex,getExplicitOrMeasuredHeight,getExplicitOrMeasuredHeight,getExplicitOrMeasuredHeight,getExplicitOrMeasuredHeight,getExplicitOrMeasuredWidth,getExplicitOrMeasuredWidth,getExplicitOrMeasuredWidth,getExplicitOrMeasuredWidth,getFirstCharInParagraph,getFirstCharInParagraph,getFocus,getImageReference,getImageReference,getImplementation,getInstance,getInstance,getInstance,getLayerAt,getLayoutBoundsHeight,getLayoutBoundsHeight,getLayoutBoundsWidth,getLayoutBoundsWidth,getLayoutBoundsX,getLayoutBoundsX,getLayoutBoundsY,getLayoutBoundsY,getLayoutMatrix,getLayoutMatrix,getLayoutMatrix3D,getLayoutMatrix3D,getLineIndexAtPoint,getLineIndexAtPoint,getLineIndexOfChar,getLineIndexOfChar,getLineLength,getLineLength,getLineMetrics,getLineMetrics,getLineOffset,getLineOffset,getLineText,getLineText,getMaxBoundsHeight,getMaxBoundsHeight,getMaxBoundsWidth,getMaxBoundsWidth,getMinBoundsHeight,getMinBoundsHeight,getMinBoundsWidth,getMinBoundsWidth,getObjectsUnderPoint,getObjectsUnderPoint,getParagraphLength,getParagraphLength,getPreferredBoundsHeight,getPreferredBoundsHeight,getPreferredBoundsWidth,getPreferredBoundsWidth,getRect,getRepeaterItem,getStyle,getStyle,getStyle,getStyle,getTextFormat,getTextFormat,getTextStyles,getTextStyles,getUITextFormat,getUITextFormat,getUITextFormat,getVisibleApplicationRect,getVisibleRect,getWindow,globalToContent,globalToContent,globalToLocal,hasCSSState,hasFormat,hasState,hasState,hitTestObject,hitTestPoint,horizontalGradientMatrix,info,initAdvancedLayoutFeatures,initializationComplete,initialize,initialize,initialize,initialize,initializeAccessibility,initializeRepeater,initializeRepeater,initializeRepeaterArrays,initializeRepeaterArrays,initialized,initialized,initialized,invalidateDisplayList,invalidateDisplayList,invalidateDisplayList,invalidateDisplayList,invalidateLayering,invalidateLayoutDirection,invalidateLayoutDirection,invalidateLayoutDirection,invalidateLayoutDirection,invalidateParentSizeAndDisplayList,invalidateProperties,invalidateProperties,invalidateProperties,invalidateProperties,invalidateProperties,invalidateSize,invalidateSize,invalidateSize,invalidateSize,isOurFocus,keyDownHandler,keyUpHandler,layoutBackgroundImage,layoutChrome,layoutChrome,localToContent,localToContent,localToGlobal,matchesCSSState,matchesCSSType,maximize,maximize,maximize,measure,measureHTMLText,measureHTMLText,measureText,measureText,minimize,minimize,minimize,mouseWheelHandler,move,move,move,move,move,move,move,move,move,newInstance,newInstance,newInstance,notifyStyleChangeInChildren,open,orderInBackOf,orderInBackOf,orderInFrontOf,orderInFrontOf,orderToBack,orderToBack,orderToFront,orderToFront,owns,owns,owns,owns,parentChanged,parentChanged,parentChanged,parentChanged,prepareToPrint,regenerateStyleCache,registerEffects,registerEffects,registerImplementation,removeAllChildren,removeAllElements,removeAllElements,removeChild,removeChild,removeChild,removeChildAt,removeChildAt,removeChildAt,removeChildBridge,removeChildBridge,removeElement,removeElement,removeElementAt,removeElementAt,removeLayer,removeStyleClient,replaceSelectedText,replaceSelectedText,replaceText,replaceText,replayAutomatableEvent,replayAutomatableEvent,replayAutomatableEvent,reset,reset,reset,resolveAutomationIDPart,resourcesChanged,restore,restore,restore,resumeBackgroundProcessing,roomForScrollBar,scrollChildren,scrollHandler,selectRange,setActualSize,setActualSize,setActualSize,setActualSize,setActualSize,setActualSize,setActualSize,setActualSize,setActualSize,setChildIndex,setChildIndex,setChildIndex,setColor,setColor,setColor,setConstraintValue,setConstraintValue,setCurrentState,setElementIndex,setElementIndex,setFocus,setFocus,setFocus,setFocus,setFocus,setLayoutBoundsPosition,setLayoutBoundsPosition,setLayoutBoundsSize,setLayoutBoundsSize,setLayoutMatrix,setLayoutMatrix,setLayoutMatrix3D,setLayoutMatrix3D,setMXMLDescriptor,setMXMLProperties,setScrollBarProperties,setSelection,setSelection,setStretchXY,setStyle,setStyle,setStyle,setTextFormat,setTextFormat,setVisible,setVisible,setVisible,setVisible,showBorderAndBackground,startDrag,stateChanged,stopDrag,styleChanged,styleChanged,styleChanged,stylesInitialized,suspendBackgroundProcessing,swapChildren,swapChildrenAt,swapElements,swapElements,swapElementsAt,swapElementsAt,toString,toString,toString,toString,toString,toString,toString,toString,toString,transformAround,transformAround,transformPointToParent,truncateToFit,truncateToFit,truncateToFit,updateDisplayList,updateDisplayList,validateDisplayList,validateDisplayList,validateNow,validateNow,validateNow,validateNow,validateNow,validateProperties,validateSize,validationResultHandler,verticalGradientMatrix"><title>mx.core.DragSource</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 = 'DragSource - 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?mx/core/DragSource.html&amp;mx/core/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">DragSource</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("DragSource"); 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')">mx.core</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class DragSource</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">DragSource <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 3</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 9, AIR 1.1</td></tr></table><p></p><p></p><p></p><p></p>
The DragSource class contains the data being dragged. The data can be in
multiple formats, depending on the type of control that initiated the drag.
<p>Each format of data is identified with a string. The
<code>hasFormat()</code> method is used to determine if the object has
data in that format. The <code>dataForFormat()</code> method is used
to retrieve the data in the specified format.</p>
<p>Data can be added directly using the <code>addData()</code> method,
or indirectly using the <code>addHandler()</code> method. The
<code>addHandler()</code> method registers a callback that will be called
if the data is requested. This is useful for adding data in a non-native
format that may require large computations or conversions. For example,
if you have raw sound data you can add an MP3 format handler. The MP3
conversion will only be done if the MP3 data is requested.</p>
<p></p><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="#formats" class="signatureLink">formats</a> : Array<div class="summaryTableDescription">[read-only]
Contains the formats of the drag data, as an Array of Strings.</div></td><td class="summaryTableOwnerCol">DragSource</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="#DragSource()" class="signatureLink">DragSource</a>()</div><div class="summaryTableDescription">
Constructor.</div></td><td class="summaryTableOwnerCol">DragSource</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addData()" class="signatureLink">addData</a>(data:Object, format:String):void</div><div class="summaryTableDescription">
Adds data and a corresponding format String to the drag source.</div></td><td class="summaryTableOwnerCol">DragSource</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addHandler()" class="signatureLink">addHandler</a>(handler:Function, format:String):void</div><div class="summaryTableDescription">
Adds a handler that is called when data
for the specified format is requested.</div></td><td class="summaryTableOwnerCol">DragSource</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#dataForFormat()" class="signatureLink">dataForFormat</a>(format:String):Object</div><div class="summaryTableDescription">
Retrieves the data for the specified format.</div></td><td class="summaryTableOwnerCol">DragSource</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#hasFormat()" class="signatureLink">hasFormat</a>(format:String):Boolean</div><div class="summaryTableDescription">
Returns true if the data source contains
the requested format; otherwise, it returns false.</div></td><td class="summaryTableOwnerCol">DragSource</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="formats"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">formats</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>formats:Array</code>&nbsp;&nbsp;[read-only] <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 3</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 9, AIR 1.1</td></tr></table><p></p><p></p><p>
Contains the formats of the drag data, as an Array of Strings.
Set this property using the <code>addData()</code>
or <code>addHandler()</code> methods.
The default value depends on data added to the DragSource object.
</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get formats():Array</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="DragSource()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">DragSource</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function DragSource()</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 3</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 9, AIR 1.1</td></tr></table><p></p><p>
Constructor.
</p></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="addData()"></a><a name="addData(Object,String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addData</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function addData(data:Object, format:String):void</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 3</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 9, AIR 1.1</td></tr></table><p></p><p></p><p>
Adds data and a corresponding format String to the drag source.
This method does not return a value.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">data</span>:Object</code> &mdash; Object that specifies the drag data.
This can be any object, such as a String, a DataProvider, and so on.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">format</span>:String</code> &mdash; String that specifies a label that describes
the format for this data.
</td></tr></table></p></div><a name="addHandler()"></a><a name="addHandler(Function,String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function addHandler(handler:Function, format:String):void</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 3</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 9, AIR 1.1</td></tr></table><p></p><p></p><p>
Adds a handler that is called when data
for the specified format is requested.
This is useful when dragging large amounts of data.
The handler is only called if the data is requested.
This method does not return a value.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">handler</span>:Function</code> &mdash; Function that specifies the handler
called to request the data.
This function must return the data in the specified format.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">format</span>:String</code> &mdash; String that specifies the format for this data.
</td></tr></table></p></div><a name="dataForFormat()"></a><a name="dataForFormat(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">dataForFormat</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function dataForFormat(format:String):Object</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 3</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 9, AIR 1.1</td></tr></table><p></p><p></p><p>
Retrieves the data for the specified format.
If the data was added with the <code>addData()</code> method,
it is returned directly.
If the data was added with the <code>addHandler()</code> method,
the handler function is called to return the data.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">format</span>:String</code> &mdash; String that specifies a label that describes
the format for the data to return. This string can be a custom value
if you are creating a custom drop target with the <code>addData()</code> method.
<p>List-based controls have predefined values
for the <code>format</code> parameter. If the control that initiated the
drag operation is a Tree, then the format is "treeItems" and the items
implement the ITreeDataProvider interface. For all other List-based
controls that have built-in drag and drop support, the format is "itemsByIndex" and the items
implement the IDataProvider interface.</p>
</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>Object</code> &mdash; An Object
containing the data in the requested format.
If you drag multiple items, the returned value is an Array.
For a List-based control, the returned value is always an Array,
even if it contains a single item.
</td></tr></table></div><a name="hasFormat()"></a><a name="hasFormat(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">hasFormat</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function hasFormat(format:String):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> Product Version :&nbsp;</b></td><td>Flex 3</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 9, AIR 1.1</td></tr></table><p></p><p></p><p>
Returns <code>true</code> if the data source contains
the requested format; otherwise, it returns <code>false</code>.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">format</span>:String</code> &mdash; String that specifies a label that describes the format
for the data.
</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; <code>true</code> if the data source contains
the requested format.
</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 -->