|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectnet.rim.device.api.ui.Field
net.rim.device.api.ui.ScrollView
net.rim.device.api.ui.Manager
net.rim.device.api.ui.component.progressindicator.AbstractProgressIndicatorView
net.rim.device.api.ui.component.progressindicator.ActivityIndicatorView
public class ActivityIndicatorView
Implementation of AbstractProgressIndicatorView that is used for
representing progress where the duration is unknown. This is especially useful
for tasks where there is no possible numeric representation for the work being done.
These tasks are typically represented by a spinner, an hourglass, or by other visual cues. This
view allows for a custom animation to be specified in order to represent the
progress underway. The custom animation takes the form of a Bitmap that contains
each frame of the animation, laid out horizontally. The length of the bitmap should
be the width of a frame times the number of frames. This field can be created by invoking
ActivityIndicatorView.createActivityImageField(net.rim.device.api.system.Bitmap, int, long), which also adds it to this view's delegate.
Both a model ActivityIndicatorModel and a controller ActivityIndicatorController
are available and represent implementations of AbstractProgressIndicatorModel and AbstractProgressIndicatorController
respectively. These are representative of progress where the duration is unknown.
If the associated controller does not consume an input event, this view allows the delegate to
process the input.
| Field Summary |
|---|
| Fields inherited from class net.rim.device.api.ui.Manager |
|---|
BOTTOMMOST, DOWNWARD, HORIZONTAL_SCROLL, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_MASK, HORIZONTAL_SCROLL_MASK, LEAVE_BLANK_SPACE, LEFTMOST, LEFTWARD, NO_HORIZONTAL_SCROLL, NO_HORIZONTAL_SCROLLBAR, NO_SCROLL_RESET, NO_VERTICAL_SCROLL, NO_VERTICAL_SCROLLBAR, QUANTA_FONT, RIGHTMOST, RIGHTWARD, TOPMOST, UPWARD, VERTICAL_SCROLL, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_MASK, VERTICAL_SCROLL_MASK |
| Constructor Summary | ||
|---|---|---|
ActivityIndicatorView(long style)
Constructs a new ActivityIndicatorView. |
||
ActivityIndicatorView(long style,
Manager delegate)
Constructs a new ActivityIndicatorView. |
||
| Method Summary | ||
|---|---|---|
void |
cancelled()
The current animation representing progress has been stopped. |
|
void |
createActivityImageField(Bitmap bitmap,
int numFrames,
long style)
Creates an ActivityImageField and adds it
to this view. |
|
static ActivityIndicatorView |
createActivityIndicator(Bitmap bitmap,
int numFrames,
long style)
Creates an ActivityIndicatorView. |
|
ActivityImageField |
getAnimation()
Returns the field that is animating progress. |
|
void |
reset()
The data model has been reset to its initial state, that is, the animation has been reset. |
|
void |
resumed()
The data model has been resumed, that is, the animation has been resumed. |
|
| Methods inherited from class net.rim.device.api.ui.component.progressindicator.AbstractProgressIndicatorView |
|---|
add, addAll, configurationChanged, createLabel, createLabel, delete, deleteAll, deleteRange, getController, getDelegate, getField, getFieldAtLocation, getFieldCount, getFieldWithFocus, getFieldWithFocusIndex, getLabel, getLabelField, getModel, insert, keyChar, keyControl, keyDown, keyRepeat, keyStatus, keyUp, navigationClick, navigationMovement, nextFocus, replace, setController, setLabel, setModel, setNonProgrammaticValue, sublayout, touchEvent |
| Methods inherited from class net.rim.device.api.ui.ScrollView |
|---|
getHorizontalAdjustment, getVerticalAdjustment, getVisibleHeight, getVisibleWidth, onDisplay, onExposed, onUndisplay, setCurrentLocation, setExtent, setHorizontalAdjustment, setHorizontalScroll, setHorizontalScroll, setScrollListener, setVerticalAdjustment, setVerticalScroll, setVerticalScroll, valueChanged, waitForScrolling |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ActivityIndicatorView(long style)
ActivityIndicatorView. The delegate
defaults to a VerticalFieldManager.
style - The style bits to set for this view.
public ActivityIndicatorView(long style,
Manager delegate)
Constructs a new ActivityIndicatorView. Requires a delegate
to be specified. If null is provided, the delegate defaults to
a VerticalFieldManager.
style - The style bits to set for this view.delegate - The Manager to use as a delegate for layout and focus.| Method Detail |
|---|
public void cancelled()
cancelled in class AbstractProgressIndicatorView
public void createActivityImageField(Bitmap bitmap,
int numFrames,
long style)
ActivityImageField and adds it
to this view. The bitmap provided must be a series of frames
laid out horizonatally, each with equal width. The total width of the bitmap
should be the width of a frame times the number of frames.
bitmap - The Bitmap containing all frames of the animation laid out horizontally,
each with equal width. The total width of the bitmap should be the width
of a frame times numFrames.numFrames - The number of equal-width frames contained in bitmap.style - The style bits to set for this field.public ActivityImageField getAnimation()
ActivityImageField being used to represent progress.public void reset()
reset in class AbstractProgressIndicatorViewpublic void resumed()
resumed in class AbstractProgressIndicatorView
public static ActivityIndicatorView createActivityIndicator(Bitmap bitmap,
int numFrames,
long style)
ActivityIndicatorView. The style of the animation field is set to Field.FIELD_HCENTER so that the frames
are laid out in a horizontal fashion.
bitmap - A bitmap to animate. The frames are to be laid out horizontally.numFrames - The number of frames in the animation.style - The style bits to set for this view.
IllegalArgumentException - thrown if bitmap is passed in as null or if numFrames is less than 0.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal