InternalHandle (Progress API)

java.lang.Object
- org.netbeans.modules.progress.spi.InternalHandle

```
public class InternalHandle
extends Object
```
Instances provided by the ProgressHandleFactory allow the users of the API to notify the progress bar UI about changes in the state of the running task.

Since:

org.netbeans.api.progress/1 1.18

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`NO_INCREASE`
`static int`	`STATE_FINISHED`
`static int`	`STATE_INITIALIZED`
`static int`	`STATE_REQUEST_STOP`
`static int`	`STATE_RUNNING`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`InternalHandle(String displayName, Cancellable cancel, boolean userInitiated)` Creates a new instance of ProgressHandle

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProgressHandle`	`createProgressHandle()` Creates a `ProgressHandle` instance, which works with this SPI.
`void`	`finish()` finish the task, remove the task's component from the progress bar UI.
`String`	`getDisplayName()`
`int`	`getInitialDelay()`
`long`	`getLastPingTime()` Returns the last time the progress was updated.
`double`	`getPercentageDone()` public because of tests.
`int`	`getState()` XXX - called from UI, threading
`long`	`getTimeStampStarted()`
`int`	`getTotalUnits()`
`boolean`	`isAllowCancel()`
`boolean`	`isAllowView()`
`boolean`	`isCustomPlaced()`
`boolean`	`isInSleepMode()`
`boolean`	`isUserInitialized()`
`protected void`	`markCustomPlaced()` Marks this handle as custom-placed.
`void`	`progress(String message, int workunit)`
`boolean`	`requestAction(String actionCommand, Action action)` Request a interaction callback to be attached to the Handle.
`void`	`requestCancel()`
`void`	`requestDisplayNameChange(String newDisplayName)`
`void`	`requestExplicitSelection()`
`ProgressEvent`	`requestStateSnapshot()`
`void`	`requestView()`
`protected void`	`setController(Controller ctrl)`
`void`	`setInitialDelay(int millis)`
`void`	`start(String message, int workunits, long estimate)` start the progress indication for a task with known number of steps and known time estimate for completing the task.
`void`	`toDeterminate(int workunits, long estimate)`
`void`	`toIndeterminate()`
`void`	`toSilent(String message)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - STATE_INITIALIZED
```
public static final int STATE_INITIALIZED
```
    See Also:
    
    Constant Field Values
  - STATE_RUNNING
```
public static final int STATE_RUNNING
```
    See Also:
    
    Constant Field Values
  - STATE_FINISHED
```
public static final int STATE_FINISHED
```
    See Also:
    
    Constant Field Values
  - STATE_REQUEST_STOP
```
public static final int STATE_REQUEST_STOP
```
    See Also:
    
    Constant Field Values
  - NO_INCREASE
```
public static final int NO_INCREASE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - InternalHandle
```
protected InternalHandle(String displayName,
                         Cancellable cancel,
                         boolean userInitiated)
```
    Creates a new instance of ProgressHandle
- Method Detail
  - createProgressHandle
```
public final ProgressHandle createProgressHandle()
```
    Creates a ProgressHandle instance, which works with this SPI.
    
    Returns:
    
    a fresh instance of ProgressHandle
    
    Since:
    
    1.40
  - getDisplayName
```
public String getDisplayName()
```
  - getState
```
public int getState()
```
    XXX - called from UI, threading
  - isAllowCancel
```
public boolean isAllowCancel()
```
  - isAllowView
```
public boolean isAllowView()
```
  - isCustomPlaced
```
public boolean isCustomPlaced()
```
  - isUserInitialized
```
public final boolean isUserInitialized()
```
  - getTotalUnits
```
public int getTotalUnits()
```
  - setInitialDelay
```
public void setInitialDelay(int millis)
```
  - getInitialDelay
```
public int getInitialDelay()
```
  - toSilent
```
public void toSilent(String message)
```
  - isInSleepMode
```
public boolean isInSleepMode()
```
  - toIndeterminate
```
public void toIndeterminate()
```
  - toDeterminate
```
public void toDeterminate(int workunits,
                          long estimate)
```
  - setController
```
protected final void setController(Controller ctrl)
```
  - start
```
public void start(String message,
                  int workunits,
                  long estimate)
```
    start the progress indication for a task with known number of steps and known time estimate for completing the task.
    
    Parameters:
    
    message -
    
    workunits -
    
    estimate - estimated time to process the task in seconds
  - finish
```
public void finish()
```
    finish the task, remove the task's component from the progress bar UI.
  - progress
```
public void progress(String message,
                     int workunit)
```
    Parameters:
    
    message -
    
    workunit -
  - requestCancel
```
public void requestCancel()
```
  - requestView
```
public void requestView()
```
  - requestExplicitSelection
```
public void requestExplicitSelection()
```
  - requestAction
```
public boolean requestAction(String actionCommand,
                             Action action)
```
    Request a interaction callback to be attached to the Handle. The implementation decides if the callback is permitted and desirable. One command, ProgressHandle.ACTION_VIEW is defined as a default command (action) for the progress handle presentation. Implementations are free to ignore request for adding actions.
    
    Parameters:
    
    actionCommand - command to bind the action for.
    
    action - action instance
    
    Returns:
    
    true, if the handle agrees to support the action.
    
    Since:
    
    1.59
  - requestDisplayNameChange
```
public void requestDisplayNameChange(String newDisplayName)
```
  - requestStateSnapshot
```
public ProgressEvent requestStateSnapshot()
```
  - getPercentageDone
```
public double getPercentageDone()
```
    public because of tests.
  - getLastPingTime
```
public long getLastPingTime()
```
    Returns the last time the progress was updated. he timestamp is updated on start, stop, every progress report and determinate / indeterminate switch. Generally every time the ProgressHandle client publishes some information.
    
    Returns:
    
    timestamp of last update, in milliseconds.
    
    Since:
    
    1.45
  - getTimeStampStarted
```
public long getTimeStampStarted()
```
  - markCustomPlaced
```
protected final void markCustomPlaced()
```
    Marks this handle as custom-placed. Handle should be marked as custom-placed if some controller overtakes (part of) handle's presentation.
    
    Since:
    
    1.59
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class InternalHandle

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATE_INITIALIZED

STATE_RUNNING

STATE_FINISHED

STATE_REQUEST_STOP

NO_INCREASE

Constructor Detail

InternalHandle

Method Detail

createProgressHandle

getDisplayName

getState

isAllowCancel

isAllowView

isCustomPlaced

isUserInitialized

getTotalUnits

setInitialDelay

getInitialDelay

toSilent

isInSleepMode

toIndeterminate

toDeterminate

setController

start

finish

progress

requestCancel

requestView

requestExplicitSelection

requestAction

requestDisplayNameChange

requestStateSnapshot

getPercentageDone

getLastPingTime

getTimeStampStarted

markCustomPlaced

toString