BBjDialChartProgress

```
public class BBjDialChartProgress
```
BBjDialChartProgress In BBj 20.00 and higher, the BBjDialChartProgress is a BBj Custom Class to help build dial charts for displaying progress (instead of a typical progress bar) more easily by acting as a proxy between a BBj program that wants to use a dial chart and the underlying JFreeChart.

The file includes a small sample program at the top of the file that demonstrates using the custom class.
THROWn Error Codes:
- 700: Missing background image file. The specified file does not exist.
See Also:
[ The source file for sample programs at the beginning of the file. This class also provides a static runDemo() method so you can see it in action by running BBjDialChartProgress.runDemo().]
Since:
BBj 20.00

Constructor Summary

Constructors
Constructor and Description
`BBjDialChartProgress()` BBjDialChartProgress constructor that creates the object with defaults Note 1: If the client's screen is HiDPI, then the underlying JFreeChart will be rendered at high resolution Note 2: if the calling program has an active `PROCESS_EVENTS` loop, then it will be possible for the user to drag and reposition the progress window
`BBjDialChartProgress(BBjString p_backgroundImagePath!)` `BBjDialChartProgress` constructor that creates the object with a custom background image Note 1: If the client's screen is HiDPI, then the underlying JFreeChart will be rendered at high resolution Note 2: You can use an image with the `@2x` suffix to indicate a HiDPI image, as in "myDialBackground@2x.png" Note 3: if the calling program has an active `PROCESS_EVENTS` loop, then it will be possible for the user to drag and reposition the progress window

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`destroy()` Method to destroy the dial chart, used when you are finished using it
`BBjNumber`	`getValue()` Method to get the dial chart's current value which is in the range from 0 to 100, indicating percentage complete
`void`	`OnMouseDown(BBjMouseDownEvent p_event!)` An internal method used by the `BBjDialChartProgress` that is called when the mouse is pressed down on the control's window. The OnMouse* events are used specifically for draggging the `BBjDialChartProgress`.
`void`	`OnMouseMove(BBjMouseMoveEvent p_event!)` An internal method used by the `BBjDialChartProgress` that is called when the mouse is moved in the control's window. The OnMouse* events are used specifically for draggging the `BBjDialChartProgress`.
`void`	`OnMouseUp(BBjMouseUpEvent p_event!)` An internal method used by the `BBjDialChartProgress` that is called when the mouse is released in the control's window. The OnMouse* events are used specifically for draggging the `BBjDialChartProgress`.
`static void`	`runDemo()` Method that runs a sample demo program for the BBjDialChartProgress class
`void`	`setValue(BBjNumber p_value)` Method to set the dial chart's value where the acceptible value ranges from 0 to 100, indicating percentage complete
`void`	`setVisible(BBjNumber p_visible)` Method to set the dial chart's window visible

Constructor Detail
- BBjDialChartProgress
```
public BBjDialChartProgress()
```
  BBjDialChartProgress constructor that creates the object with defaults
  
  Note 1: If the client's screen is HiDPI, then the underlying JFreeChart will be rendered at high resolution
  Note 2: if the calling program has an active PROCESS_EVENTS loop, then it will be possible for the user to drag and reposition the progress window
- BBjDialChartProgress
```
public BBjDialChartProgress(BBjString p_backgroundImagePath!)
```
  BBjDialChartProgress constructor that creates the object with a custom background image
  
  Note 1: If the client's screen is HiDPI, then the underlying JFreeChart will be rendered at high resolution
  Note 2: You can use an image with the @2x suffix to indicate a HiDPI image, as in "myDialBackground@2x.png"
  Note 3: if the calling program has an active PROCESS_EVENTS loop, then it will be possible for the user to drag and reposition the progress window
  Parameters:
  p_backgroundImagePath! A BBjString with the fully-qualified path to an image file that will be used as the chart's background

- Method Detail
  - destroy
```
public void destroy()
```
    Method to destroy the dial chart, used when you are finished using it
  - getValue
```
public BBjNumber getValue()
```
    Method to get the dial chart's current value which is in the range from 0 to 100, indicating percentage complete
  - OnMouseDown
```
public void OnMouseDown(BBjMouseDownEvent p_event!)
```
    An internal method used by the BBjDialChartProgress that is called when the mouse is pressed down on the control's window. The OnMouse* events are used specifically for draggging the BBjDialChartProgress.
    
    Parameters:
    p_event! BBjMouseDownEvent that contains event information
  - OnMouseMove
```
public void OnMouseMove(BBjMouseMoveEvent p_event!)
```
    An internal method used by the BBjDialChartProgress that is called when the mouse is moved in the control's window. The OnMouse* events are used specifically for draggging the BBjDialChartProgress.
    
    Parameters:
    p_event! BBjMouseMoveEvent that contains event information
  - OnMouseUp
```
public void OnMouseUp(BBjMouseUpEvent p_event!)
```
    An internal method used by the BBjDialChartProgress that is called when the mouse is released in the control's window. The OnMouse* events are used specifically for draggging the BBjDialChartProgress.
    
    Parameters:
    p_event! BBjMouseUpEvent that contains event information
  - runDemo
```
public static void runDemo()
```
    Method that runs a sample demo program for the BBjDialChartProgress class
  - setValue
```
public void setValue(BBjNumber p_value)
```
    Method to set the dial chart's value where the acceptible value ranges from 0 to 100, indicating percentage complete
  - setVisible
```
public void setVisible(BBjNumber p_visible)
```
    Method to set the dial chart's window visible

Class BBjDialChartProgress

Constructor Summary

Method Summary

Constructor Detail

BBjDialChartProgress

BBjDialChartProgress

Method Detail

destroy

getValue

OnMouseDown

OnMouseMove

OnMouseUp

runDemo

setValue

setVisible