blob: f3a67e53600bcef6f707b367b3186f940f9a7fef [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="ProgressBarMode,mx.controls.ProgressBarMode,BOTTOM,BOTTOM,BYTES,CANCEL,CENTER,COLUMN_AXIS,COMPUTER,COMPUTER,COMPUTER,COMPUTER,DIRECTORIES_FIRST,DIRECTORIES_ONLY,EVENT,FILES_AND_DIRECTORIES,FILES_FIRST,FILES_ONLY,HEADER_ICON_PART,HEADER_TEXT_PART,KILOBYTES,LEFT,LEFT,LEFT,MANUAL,NO,NONMODAL,OK,OLAP_DIMENSION,OLAP_HIERARCHY,OLAP_LEVEL,OLAP_MEMBER,POLLED,RIGHT,RIGHT,RIGHT,ROW_AXIS,SLICER_AXIS,TOP,TOP,YES,alignToolTip,allowDisjointSelection,allowMultipleSelection,anchorColumnIndex,arrowButtonStyleFilters,autoBandWidthDetection,autoLoad,autoPlay,autoRepeat,autoRewind,autoStop,automationDelegate,automationEnabled,automationName,automationOwner,automationParent,automationTabularData,automationValue,automationVisible,backHistory,backHistory,boldToolTip,border,borderMetrics,borderMetrics,bufferTime,bulletToolTip,buttonFlags,buttonHeight,buttonWidth,bytesLoaded,bytesLoaded,bytesTotal,bytesTotal,calendarLayoutStyleFilters,canNavigateBack,canNavigateBack,canNavigateDown,canNavigateDown,canNavigateForward,canNavigateForward,canNavigateUp,canNavigateUp,cancelLabel,caretColumnIndex,cellSelectionTweens,childAllowsParent,closeOnActivity,collection,colorField,colorPickerToolTip,columns,columns,condenseWhite,condenseWhite,condenseWhite,content,contentHeight,contentHeight,contentWidth,contentWidth,conversion,creationDateColumn,cuePointManager,cuePointManagerClass,cuePoints,data,data,data,data,data,data,data,data,data,data,dataDescriptor,dataDescriptor,dataDescriptor,dataDescriptor,dataDescriptor,dataProvider,dataProvider,dataProvider,dataProvider,dataProvider,dataProvider,dataProvider,dataProvider,dataProvider,dateFormatString,dayNames,dayNames,defaultButtonFlag,defaultCellString,defaultLinkProtocol,direction,directory,directory,directory,directory,disabledDays,disabledDays,disabledRanges,disabledRanges,displayAsPassword,displayAsPassword,displayDisclosureIcon,displayItemsExpanded,displayedMonth,displayedMonth,displayedYear,displayedYear,domWindow,downArrowStyleFilters,dragMoveEnabled,draggableColumns,draggableColumns,dropDownStyleFilters,dropdown,dropdown,dropdownFactory,dropdownFactory,dropdownWidth,editable,editable,editable,editable,editable,editable,editedItemPosition,editedItemPosition,editedItemPosition,editedItemRenderer,editedItemRenderer,editedItemRenderer,editorDataField,editorHeightOffset,editorUsesEnterKey,editorWidthOffset,editorXOffset,editorYOffset,emphasized,enableIME,enableIME,enableIME,enableIME,enableIME,enableIME,enableIME,enabled,enabledField,enumerationMode,enumerationMode,enumerationMode,extensions,extensions,extensions,filterFunction,filterFunction,filterFunction,firstDayOfWeek,firstDayOfWeek,firstVisibleItem,firstVisibleItem,fontContext,fontContext,fontContext,fontContext,fontFamilyToolTip,fontSizeToolTip,formatString,forwardHistory,forwardHistory,group,groupIconFunction,groupItemRenderer,groupLabelFunction,groupName,groupRowHeight,groupedColumns,hasRoot,hasRoot,hasRoot,hasRoot,headerInfoInitialized,headerRendererProviders,hierarchicalCollectionView,highlightColumnIndex,historyLength,historyPosition,horizontalScrollPolicy,horizontalScrollPosition,horizontalScrollPosition,horizontalScrollPosition,horizontalScrollPosition,horizontalScrollPosition,htmlHost,htmlLoader,htmlLoaderFactory,htmlText,htmlText,htmlText,htmlText,htmlText,iconClass,iconField,iconField,iconField,iconFunction,icons,idleTimeout,imeMode,imeMode,imeMode,imeMode,imeMode,imeMode,imeMode,imeMode,indent,indeterminate,initialized,inputFieldStyleFilters,isKeyPressed,italicToolTip,itemEditor,itemEditorInstance,itemEditorInstance,itemEditorInstance,itemIcons,itemIcons,itemRenderer,itemRendererProviders,iterator,keyEquivalentField,keyEquivalentFunction,keyEquivalentModifiersFunction,label,label,labelField,labelField,labelField,labelField,labelField,labelField,labelFunction,labelFunction,labelFunction,labelFunction,labelFunction,labelFunction,labelPlacement,labelPlacement,labelPlacement,labelPlacement,length,length,linkToolTip,listData,listData,listData,listData,listData,listData,listData,listData,listData,listData,live,loadForCompatibility,loaded,loaderContext,location,lockedColumnCount,lockedRowCount,lookAheadDuration,maintainAspectRatio,maintainAspectRatio,maxChars,maxChars,maxChars,maxHorizontalScrollPosition,maxWidth,maxYear,maxYear,maximum,maximum,measuringObjects,menuBarItemRenderer,menuBarItemStyleFilters,menuBarItems,menus,metadata,minColumnWidth,minColumnWidth,minYear,minYear,minimum,minimum,mnemonicIndexField,mnemonicIndexFunction,mode,modificationDateColumn,monthNames,monthNames,monthSymbol,monthSymbol,movieClip,nameColumn,nameCompareFunction,nameCompareFunction,nameCompareFunction,nativeMenu,nestLevel,nextMonthStyleFilters,nextValue,nextYearStyleFilters,noLabel,numAutomationChildren,numRadioButtons,okLabel,openAlways,openItems,openPaths,orderedHeadersList,paintsDefaultBackground,parentAllowsChild,parentDrawsFocus,parentDrawsFocus,parentMenu,parseFunction,pdfCapability,percentComplete,percentLoaded,playheadTime,playheadUpdateInterval,playing,popUp,popUp,prevMonthStyleFilters,prevYearStyleFilters,previousValue,processedDescriptors,progressInterval,prompt,rendererDescriptionMap,rendererIsEditor,rendererProviders,resizableColumns,resizableColumns,restrict,restrict,restrict,rowCount,runtimeApplicationDomain,scaleContent,selectable,selectable,selectable,selectableRange,selectableRange,selected,selectedCells,selectedColor,selectedColumnIndex,selectedDate,selectedDate,selectedField,selectedIndex,selectedIndex,selectedIndex,selectedIndex,selectedIndex,selectedIndex,selectedIndex,selectedItem,selectedItem,selectedLabel,selectedPath,selectedPath,selectedPath,selectedPaths,selectedPaths,selectedPaths,selectedRanges,selectedValue,selection,selection,selectionActivePosition,selectionAnchorPosition,selectionBeginIndex,selectionBeginIndex,selectionEndIndex,selectionEndIndex,showBusyCursor,showControlBar,showExtensions,showExtensions,showExtensions,showHidden,showHidden,showHidden,showIcons,showIcons,showIcons,showIcons,showInAutomationHierarchy,showRoot,showRoot,showRoot,showRoot,showRoot,showTextField,showToday,showToday,showToolTips,sizeColumn,sizeDisplayMode,smoothBitmapContent,sortExpertMode,sortableColumns,sortableColumns,source,source,source,state,stateResponsive,stepSize,stickyHighlighting,styleFunction,styleSheet,styleSheet,swatchStyleFilters,swfBridge,text,text,text,text,text,text,text,textField,textField,textField,textField,textField,textHeight,textHeight,textHeight,textInput,textInputStyleFilters,textWidth,textWidth,textWidth,toggle,toggleOnClick,toolTipField,totalTime,treeColumn,treeColumnIndex,truncateToFit,trustContent,tween,typeColumn,underlineToolTip,upArrowStyleFilters,updateCompletePendingFlag,userAgent,value,value,value,value,verticalScrollPolicy,verticalScrollPosition,videoHeight,videoWidth,visibleCellRenderers,volume,wordWrap,yearNavigationEnabled,yearNavigationEnabled,yearSymbol,yearSymbol,yesLabel"><title>mx.controls.ProgressBarMode</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 = 'ProgressBarMode - 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/controls/ProgressBarMode.html&amp;mx/controls/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">ProgressBarMode</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#constantSummary">Constants</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("ProgressBarMode"); titleBar_setSubNav(true,false,false,false,false,false,false,false,false,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.controls</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public final class ProgressBarMode</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">ProgressBarMode <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 ProgressBarMode class defines the values for the <code>mode</code> property
of the ProgressBar class.
<p></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="ProgressBar.html" target="">mx.controls.ProgressBar</a></div><br/><hr></div><a name="constantSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Constants</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableConstant"><tr><th>&nbsp;</th><th colspan="2">Constant</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="#EVENT" class="signatureLink">EVENT</a> : String = event<div class="summaryTableDescription">[static]
The control specified by the source property must
dispatch progress and completed events.</div></td><td class="summaryTableOwnerCol">ProgressBarMode</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#MANUAL" class="signatureLink">MANUAL</a> : String = manual<div class="summaryTableDescription">[static]
You manually update the ProgressBar status.</div></td><td class="summaryTableOwnerCol">ProgressBarMode</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#POLLED" class="signatureLink">POLLED</a> : String = polled<div class="summaryTableDescription">[static]
The source property must specify an object that
exposes the getBytesLoaded() and
getBytesTotal() methods.</div></td><td class="summaryTableOwnerCol">ProgressBarMode</td></tr></table></div><script language="javascript" type="text/javascript"><!--
showHideInherited();
--></script><div class="MainContent"><div class="detailSectionHeader">Constant Detail</div><a name="constantDetail"></a><a name="EVENT"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">EVENT</td><td class="detailHeaderType">Constant</td></tr></table><div class="detailBody"><code>public static const EVENT:String = event</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>
The control specified by the <code>source</code> property must
dispatch <code>progress</code> and <code>completed</code> events.
The ProgressBar uses these events to update its status.
</p></div><a name="constantDetail"></a><a name="MANUAL"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">MANUAL</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>public static const MANUAL:String = manual</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>
You manually update the ProgressBar status. In this mode, you
specify the <code>maximum</code> and <code>minimum</code>
properties and use the <code>setProgress()</code> method
to specify the status. This mode is often used when the
<code>indeterminate</code> property is <code>true</code>.
</p></div><a name="constantDetail"></a><a name="POLLED"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">POLLED</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>public static const POLLED:String = polled</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>
The <code>source</code> property must specify an object that
exposes the <code>getBytesLoaded()</code> and
<code>getBytesTotal()</code> methods. The ProgressBar control
calls these methods to update its status.
</p></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 -->