public class FlexProgressBar extends FlexObject
A determinate ProgressBar control is a linear representation of the progress of a task over time. You use a determinate ProgressBar when the scope of the task is known. It displays when the user has to wait for an extended amount of time.
An indeterminate ProgressBar control represents time-based processes for which the scope is not yet known. As soon as you can determine the scope, you should use a determinate ProgressBar control.
Modifier | Constructor and Description |
---|---|
protected |
FlexProgressBar(JtfObjectHandle handle,
Desktop desktop)
Creates a new FlexProgressBar with a JtfObjectHandle.
|
Modifier and Type | Method and Description |
---|---|
Color |
getBarColor()
Gets the color of a ProgressBar.
|
Color |
getBorderColor()
Gets the black section of a three-dimensional border, or the color section of a two-dimensional border.
|
Color |
getColor()
Gets the color of text in the component, including the component label.
|
double |
getConversion()
Gets the number used to convert incoming current bytes loaded value and the total bytes loaded values.
|
String |
getDirection()
Gets the direction in which the fill of the ProgressBar expands toward completion.
|
Color |
getDisabledColor()
Gets the color of text in the component if it is disabled.
|
List<Color> |
getFillColors()
Gets the colors used to tint the background fill of the component.
|
String |
getFontFamily()
Gets the name of the font to use.
|
double |
getFontSize()
Gets the height of the text, in pixels.
|
String |
getFontStyle()
Gets whether the text is italic font.
|
String |
getFontWeight()
Gets whether the text is boldface.
|
String |
getLabel()
Gets the text that accompanies the progress bar.
|
String |
getLabelPlacement()
Gets the placement of the label.
|
double |
getLabelWidth()
Gets the width of the label in pixels.
|
double |
getMaximum()
Gets the largest progress value for the ProgressBar.
|
double |
getMinimum()
Gets the smallest progress value for the ProgressBar.
|
double |
getPercentComplete()
Gets the percentage of process that is completed.
|
String |
getTextAlign()
Gets the alignment of text within a container.
|
String |
getTextDecoration()
Gets whether the text is underlined.
|
double |
getTextIndent()
Gets the offset of first line of text from the left side of the container, in pixels.
|
Double |
getValue()
Gets the amount of progress that has been made between the minimum and maximum values.
|
boolean |
isIndeterminate()
Gets whether the ProgressBar control has a determinate or indeterminate appearance.
|
changeFocus, changeFocus, changeFocus, getAutomationClassName, getAutomationIndex, getAutomationName, getClassName, getCurrentState, getErrorColor, getErrorString, getId, getNumAutomationChildren, getPercentHeight, getPercentWidth, getScaleX, getScaleY, getThemeColor, getToolTip, isEnabled, isFocusEnabled, isUseHandCursor, move, move, move, setFocus
click, click, click, click, doubleClick, doubleClick, doubleClick, doubleClick, getAlpha, getHeight, getStyle, getTabIndex, getWidth, getX, getY, isMouseEnabled, isTabChildren, isTabEnabled, isVisible, mouseMove, mouseMove, nativeToString, pressKeys, pressKeys, pressMouse, pressMouse, pressMouse, pressMouse, releaseKeys, releaseKeys, releaseMouse, releaseMouse, releaseMouse, releaseMouse, typeKeys, typeKeys, typeKeys, typePasswordKeys, typePasswordKeys, typePasswordKeys
captureBitmap, captureBitmap, exists, exists, generateLocator, getChildren, getDynamicMethodList, getParent, getPropertyList, getRect, getRect, getText, highlightObject, highlightObject, highlightObject, invokeMethods, textCapture, textCapture, textClick, textClick, textClick, textClick, textClick, textClick, textExists, textExists, textExists, textExists, textExists, textRectangle, textRectangle, textRectangle, textRectangle, textRectangle, waitForChildDisappearance, waitForChildDisappearance, waitForDisappearance, waitForDisappearance, waitForObject, waitForObject, waitForProperty, waitForProperty
equals, exists, find, find, findAll, findAll, getCustomTypeName, getDesktop, getHandle, getLocator, getProperty, getTypeName, hashCode, imageClick, imageClick, imageClick, imageClick, imageClick, imageClick, imageClickFile, imageClickFile, imageClickFile, imageClickFile, imageClickFile, imageClickFile, imageExists, imageExists, imageExists, imageExistsFile, imageExistsFile, imageExistsFile, imageRectangle, imageRectangle, imageRectangle, imageRectangleFile, imageRectangleFile, imageRectangleFile, invoke, preventFinalLocator, setProperty, toString
protected FlexProgressBar(JtfObjectHandle handle, Desktop desktop)
handle
- the handle that identifies the FlexProgressBardesktop
- the desktop on which this object livespublic Color getBarColor()
A ProgressBar is filled with a vertical gradient between this color and a brighter color computed from it. This style has no effect on other components, but can be set on a container to control the appearance of all progress bars found within. The default value is undefined, which means it is not set. In this case, the themeColor style property is used.
public Color getBorderColor()
public Color getColor()
public double getConversion()
Flex divides the current and total values by this property and uses the closest integer that is less than or equal to each value in the label string. A value of 1 does no conversion.
The default value is 1.
public String getDirection()
In ActionScript, you use use the following constants to set this property: ProgressBarDirection.RIGHT
and ProgressBarDirection.LEFT
.
The default value is ProgressBarDirection.RIGHT
.
public Color getDisabledColor()
public List<Color> getFillColors()
Set this to an Array of either two or four unit values that specify RGB colors. Elements 0 and 1 specify the start and end values for a color gradient. If elements 2 and 3 exist, they are used instead of elements 0 and 1 when the component is in a mouse-over state. For a flat-looking control, set the same color for elements 0 and 1 and for elements 2 and 3, The default value is [ 0xFFFFFF, 0xCCCCCC, 0xFFFFFF, 0xEEEEEE ].
Some components, such as the ApplicationControlBar container, have a different default value. For the ApplicationControlBar container, the default value is [ 0xFFFFFF, 0xFFFFFF ].
Deprecated Since 3.0: Use headerStyleName
public String getFontFamily()
Unlike in a full CSS implementation, comma-separated lists are not supported. You can use any font family name. If you specify a generic font name, it is converted to an appropriate device font. The default value is Verdana
.
public double getFontSize()
The default value is 10 for all controls except the ColorPicker control. For the ColorPicker control, the default value is 11.
public String getFontStyle()
Recognized values are normal
and italic
. The default value is normal
.
public String getFontWeight()
Recognized values are normal and bold. The default value for Button controls is bold. The default value for all other controls is normal.
public boolean isIndeterminate()
Use an indeterminate appearance when the progress status cannot be determined. If true, the appearance is indeterminate. The default value is false.
public String getLabel()
You can include the following special characters in the text string:
If a field is unknown, it is replaced by "??". If undefined, the label is not displayed.
public String getLabelPlacement()
Valid values in MXML are: right, left, bottom, center, and top.
In ActionScript, you can use use the following constants to set this property: ProgressBarLabelPlacement.RIGHT
, ProgressBarLabelPlacement.LEFT
, ProgressBarLabelPlacement.BOTTOM
, ProgressBarLabelPlacement.CENTER
, and ProgressBarLabelPlacement.TOP
.
The default value is ProgressBarLabelPlacement.BOTTOM
.
public double getLabelWidth()
If the value is NaN, the ProgressBar control sets it to the width of the control. The default value is NaN.
public double getMaximum()
The default value is 0.
public double getMinimum()
The default value is 0.
public double getPercentComplete()
public String getTextAlign()
Possible values are:left, right, or center.
The default value for most components is left. For the FormItem component, the default value is right. For the Button, LinkButton, and AccordionHeader components, the default value is center, and this property is only recognized when the labelPlacement property is set to left or right. If labelPlacement is set to top or bottom, the text and any icon are centered.
public String getTextDecoration()
Possible values are none
and underline
. The default value is none
.
public double getTextIndent()
public Double getValue()
getValue
in class TestObject
Copyright 2009-2012 Micro Focus. All Rights Reserved.