ScreenCapture

java.lang.Object
- ScreenCapture.ScreenCapture

public class ScreenCapture
extends Object

ScreenCapture Screen Capture Class

Constructor Summary

Constructors
Constructor and Description

ScreenCapture()

Constructors
Constructor and Description
`ScreenCapture()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static BBjString`	`capture()` Method capture: Capture entire screen directly to the client default temporary directory, without the file save dialog
`static BBjString`	`capture(BBjMDI p_mdi!)` Method capture: Capture a MDI window, defaulting the client file path, without showing the save dialog
`static BBjString`	`capture(BBjMDI p_mdi!, BBjNumber p_useClient)` Method capture: Capture a MDI, defaulting the file path, without showing the save dialog
`static BBjString`	`capture(BBjMDI p_mdi!, BBjString p_filepath$)` Method capture: Capture a MDI window, saving to the given client file path, without showing the save dialog
`static BBjString`	`capture(BBjMDI p_mdi!, BBjString p_filepath$, BBjNumber p_show)` Method capture: Capture a MDI window, saving to the given client file path, and optionally showing the save dialog
`static BBjString`	`capture(BBjMDI p_mdi!, BBjString p_filepath$, BBjNumber p_show, BBjNumber p_useClient)` Method capture: Capture a MDI window, saving to the given file path, and optionally showing the save dialog
`static BBjString`	`capture(BBjNumber p_useClient)` Method capture: Capture entire screen directly to the default temporary directory, without the file save dialog
`static BBjString`	`capture(BBjString p_filepath$)` Method capture: Capture entire screen directly to the given client file path, without the file save dialog
`static BBjString`	`capture(BBjString p_filepath$, BBjNumber p_show)` Method capture: Capture entire screen to the given client file path, optionally showing the file save dialog
`static BBjString`	`capture(BBjString p_filepath$, BBjNumber p_show, BBjNumber p_useClient)` Method capture: Capture entire screen to the given file path, optionally showing the file save dialog
`static BBjString`	`capture(BBjWindow p_win!)` Method capture: Capture a top-level or child window, defaulting the client file path, without showing the save dialog
`static BBjString`	`capture(BBjWindow p_win!, BBjNumber p_useClient)` Method capture: Capture a top-level or child window, defaulting the file path, without showing the save dialog
`static BBjString`	`capture(BBjWindow p_win!, BBjString p_filepath$)` Method capture: Capture a top-level or child window, saving to the given client file path, without showing the save dialog
`static BBjString`	`capture(BBjWindow p_win!, BBjString p_filepath$, BBjNumber p_show)` Method capture: Capture a top-level or child window, saving to the given client file path, and optionally showing the save dialog
`static BBjString`	`capture(BBjWindow p_win!, BBjString p_filepath$, BBjNumber p_show, BBjNumber p_useClient)` Method capture: Capture a top-level or child window, saving to the given file path, and optionally showing the save dialog
`static BBjImage`	`getScreenImage()` Method getScreenImage: Capture an image of the entire screen
`static BBjString`	`getTempDir()` Method getTempDir: Get temporary directory path
`static BBjString`	`getTempDir(BBjNumber p_useClient)` Method getTempDir: Get temporary directory path on server or client
`static BBjString`	`saveCapture(BBjImage p_image!, BBjString p_filepath$, BBjNumber p_show)` Method saveCapture: Save a given captured image to the given client file path, and optionally showing the save dialog
`static BBjString`	`saveCapture(BBjImage p_image!, BBjString p_filepath$, BBjNumber p_show, BBjNumber p_useClient)` Method saveCapture: Save a given captured image to the given file path, and optionally showing the save dialog

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

- Constructor Detail
  - ScreenCapture
```
public ScreenCapture()
```
- Method Detail
  - capture
```
public static BBjString capture()
```
    Method capture: Capture entire screen directly to the client default temporary directory, without the file save dialog
    
    Returns:
    
    BBjString Absolute path to file containing image or an empty string, if file wasn't saved
  - capture
```
public static BBjString capture(BBjString p_filepath$)
```
    Method capture: Capture entire screen directly to the given client file path, without the file save dialog
    
    Parameters:
    
    BBjString - Optional path to client file in which the image is saved
    Defaults to file beginning with "scrncap_" in the default temporary directory
    
    Returns:
    
    BBjString Absolute path to file containing image or an empty string, if file wasn't saved
  - capture
```
public static BBjString capture(BBjString p_filepath$,
BBjNumber p_show)
```
    Method capture: Capture entire screen to the given client file path, optionally showing the file save dialog
    
    Parameters:
    
    BBjString - Optional path to client file in which the image is saved
    Defaults to file beginning with "scrncap_" in the default temporary directory
    
    BBjNumber - Boolean flag whether save dialog should be displayed
    
    Returns:
    
    BBjString Absolute path to file containing image or an empty string, if file wasn't saved
  - saveCapture
```
public static BBjString saveCapture(BBjImage p_image!,
BBjString p_filepath$,
BBjNumber p_show)
```
    Method saveCapture: Save a given captured image to the given client file path, and optionally showing the save dialog
    
    Parameters:
    
    BBjImage - Captured image
    
    BBjString - Optional path to client file in which the image is saved
    Defaults to file beginning with "scrncap_" in the default temporary directory
    
    BBjNumber - Boolean flag whether save dialog should be displayed
    
    Returns:
    
    BBjString Absolute path to file containing image or an empty string, if file wasn't saved
  - capture
```
public static BBjString capture(BBjNumber p_useClient)
```
    Method capture: Capture entire screen directly to the default temporary directory, without the file save dialog
    
    Parameters:
    
    BBjNumber - Boolean flag whether the file should be saved on the client. This cannot be true when running in BUI
    
    Returns:
    
    BBjString Absolute path to file containing image or an empty string, if file wasn't saved
  - capture
```
public static BBjString capture(BBjString p_filepath$,
BBjNumber p_show,
BBjNumber p_useClient)
```
    Method capture: Capture entire screen to the given file path, optionally showing the file save dialog
    
    Parameters:
    
    BBjString - Optional path to file in which the image is saved
    Defaults to file beginning with "scrncap_" in the default temporary directory
    
    BBjNumber - Boolean flag whether save dialog should be displayed
    
    BBjNumber - Boolean flag whether the file should be saved on the client. This cannot be true when running in BUI
    
    Returns:
    
    BBjString Absolute path to file containing image or an empty string, if file wasn't saved
  - capture
```
public static BBjString capture(BBjWindow p_win!)
```
    Method capture: Capture a top-level or child window, defaulting the client file path, without showing the save dialog
    
    Parameters:
    
    BBjWindow - Top-level or child window object
    
    Returns:
    
    BBjString Absolute path to file containing image or an empty string, if file wasn't saved
  - capture
```
public static BBjString capture(BBjWindow p_win!,
BBjString p_filepath$)
```
    Method capture: Capture a top-level or child window, saving to the given client file path, without showing the save dialog
    
    Parameters:
    
    BBjWindow - Top-level or child window object
    
    BBjString - Optional path to file in which the image is saved
    
    Returns:
    
    BBjString Absolute path to file containing image or an empty string, if file wasn't saved
  - capture
```
public static BBjString capture(BBjWindow p_win!,
BBjString p_filepath$,
BBjNumber p_show)
```
    Method capture: Capture a top-level or child window, saving to the given client file path, and optionally showing the save dialog
    
    Parameters:
    
    BBjWindow - Top-level or child window object
    
    BBjString - Optional path to file in which the image is saved
    
    BBjNumber - Boolean flag whether save dialog should be displayed
    
    Returns:
    
    BBjString Absolute path to file containing image or an empty string, if file wasn't saved
  - capture
```
public static BBjString capture(BBjWindow p_win!,
BBjNumber p_useClient)
```
    Method capture: Capture a top-level or child window, defaulting the file path, without showing the save dialog
    
    Parameters:
    
    BBjWindow - Top-level or child window object
    
    BBjNumber - Boolean flag whether the file should be saved on the client. This cannot be true when running in BUI
    
    Returns:
    
    BBjString Absolute path to file containing image or an empty string, if file wasn't saved
  - capture
```
public static BBjString capture(BBjWindow p_win!,
BBjString p_filepath$,
BBjNumber p_show,
BBjNumber p_useClient)
```
    Method capture: Capture a top-level or child window, saving to the given file path, and optionally showing the save dialog
    
    Parameters:
    
    BBjWindow - Top-level or child window object
    
    BBjString - Optional path to file in which the image is saved
    
    BBjNumber - Boolean flag whether save dialog should be displayed
    
    BBjNumber - Boolean flag whether the file should be saved on the client. This cannot be true when running in BUI
    
    Returns:
    
    BBjString Absolute path to file containing image or an empty string, if file wasn't saved
  - capture
```
public static BBjString capture(BBjMDI p_mdi!)
```
    Method capture: Capture a MDI window, defaulting the client file path, without showing the save dialog
    
    Parameters:
    
    BBjMDI - MDI object
    
    Returns:
    
    BBjString Absolute path to file containing image or an empty string, if file wasn't saved
  - capture
```
public static BBjString capture(BBjMDI p_mdi!,
BBjString p_filepath$)
```
    Method capture: Capture a MDI window, saving to the given client file path, without showing the save dialog
    
    Parameters:
    
    BBjMDI - MDI object
    
    BBjString - Optional path to file in which the image is saved
    
    Returns:
    
    BBjString Absolute path to file containing image or an empty string, if file wasn't saved
  - capture
```
public static BBjString capture(BBjMDI p_mdi!,
BBjString p_filepath$,
BBjNumber p_show)
```
    Method capture: Capture a MDI window, saving to the given client file path, and optionally showing the save dialog
    
    Parameters:
    
    BBjMDI - MDI object
    
    BBjString - Optional path to file in which the image is saved
    
    BBjNumber - Boolean flag whether save dialog should be displayed
    
    Returns:
    
    BBjString Absolute path to file containing image or an empty string, if file wasn't saved
  - capture
```
public static BBjString capture(BBjMDI p_mdi!,
BBjNumber p_useClient)
```
    Method capture: Capture a MDI, defaulting the file path, without showing the save dialog
    
    Parameters:
    
    BBjMDI - MDI object
    
    BBjNumber - Boolean flag whether the file should be saved on the client. This cannot be true when running in BUI
    
    Returns:
    
    BBjString Absolute path to file containing image or an empty string, if file wasn't saved
  - capture
```
public static BBjString capture(BBjMDI p_mdi!,
BBjString p_filepath$,
BBjNumber p_show,
BBjNumber p_useClient)
```
    Method capture: Capture a MDI window, saving to the given file path, and optionally showing the save dialog
    
    Parameters:
    
    BBjMDI - MDI object
    
    BBjString - Optional path to file in which the image is saved
    
    BBjNumber - Boolean flag whether save dialog should be displayed
    
    BBjNumber - Boolean flag whether the file should be saved on the client. This cannot be true when running in BUI
    
    Returns:
    
    BBjString Absolute path to file containing image or an empty string, if file wasn't saved
  - saveCapture
```
public static BBjString saveCapture(BBjImage p_image!,
BBjString p_filepath$,
BBjNumber p_show,
BBjNumber p_useClient)
```
    Method saveCapture: Save a given captured image to the given file path, and optionally showing the save dialog
    
    Parameters:
    
    BBjImage - Captured image
    
    BBjString - Optional path to file in which the image is saved
    Defaults to file beginning with "scrncap_" in the default temporary directory
    
    BBjNumber - Boolean flag whether save dialog should be displayed
    
    BBjNumber - Boolean flag whether the file should be saved on the client. This cannot be true when running in BUI
    
    Returns:
    
    BBjString Absolute path to file containing image or an empty string, if file wasn't saved
  - getTempDir
```
public static BBjString getTempDir()
```
    Method getTempDir: Get temporary directory path
    
    Returns:
    
    BBjString Temporary directory path
  - getScreenImage
```
public static BBjImage getScreenImage()
```
    Method getScreenImage: Capture an image of the entire screen
    
    Returns:
    
    BBjImage Captured screen image
  - getTempDir
```
public static BBjString getTempDir(BBjNumber p_useClient)
```
    Method getTempDir: Get temporary directory path on server or client
    
    Parameters:
    
    BBjNumber - Boolean flag whether client environment should be used
    
    Returns:
    
    BBjString Temporary directory path

Class ScreenCapture

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ScreenCapture

Method Detail

capture

capture

capture

saveCapture

capture

capture

capture

capture

capture

capture

capture

capture

capture

capture

capture

capture

saveCapture

getTempDir

getScreenImage

getTempDir