BBJasper

Class BBJasperViewerWindow

java.lang.Object

BBJasper.BBJasperViewerWindow

public class BBJasperViewerWindow
extends Object

Displays a JasperReport in a window where the user can view it, save it to disk in various formats, and print it

Since:

9.0

See Also:

Example

Field Summary

Fields

Modifier and Type	Field and Description
BBJasperViewerControl	ParentViewerControl! The parent BBJasperViewerControl
BBjNumber	ReleaseOnClose When set to TRUE (1), the interpreter running the viewer window will release when closed by the user
static BBjString	VIEWER_WINDOW_NAME$ Constant which represents the viewer window name
static BBjNumber	WINDOW_ERROR Constant which represents that an error occured in the window

Constructor Summary

Constructors

Constructor and Description
BBJasperViewerWindow(BBJasperReport p_report!) Constructs a BBJasperViewerWindow given a BBJasperReport object
BBJasperViewerWindow(BBJasperReport p_report!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_title!, BBjString p_flags$) Constructs a BBJasperViewerWindow given a BBJasperReport object, window x, window y, window width, window height, window title, and window flags
BBJasperViewerWindow(BBJasperReport p_report!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_title!, BBjString p_flags$, BBjNumber p_fitType) Constructs a BBJasperViewerWindow given a BBJasperReport object, window x, window y, window width, window height, window title, window flags, and fit type
BBJasperViewerWindow(BBJasperReport p_report!, BBjString p_title!) Constructs a BBJasperViewerWindow given a BBJasperReport object and a window title
BBJasperViewerWindow(BBJasperReport p_report!, BBjString p_title!, BBjString p_flags$) Constructs a BBJasperViewerWindow given a BBJasperReport object, window title, and window flags
BBJasperViewerWindow(BBJasperViewerControl p_parentViewerControl!, BBJasperReport p_report!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_title!, BBjString p_flags$, BBjNumber p_fitType) Constructs a BBJasperViewerWindow given a parent BBJasperViewercontrol object, BBJasperReport object, window x, window y, window width, window height, window title, and window flags
BBJasperViewerWindow(BBJasperViewerControl p_parentViewerControl!, BBjVector p_reports!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_title!, BBjString p_flags$, BBjNumber p_fitType) Constructs a BBJasperViewerWindow given a parent BBJasperViewercontrol object, BBJasperReport object, window x, window y, window width, window height, window title, and window flags
BBJasperViewerWindow(BBJasperViewerControl p_parentViewerControl!, JasperPrint p_jasperPrint!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_title!, BBjString p_flags$, BBjNumber p_fitType) Constructs a BBJasperViewerWindow given a parent JasperViewerControl object, JasperPrint object, window X, window Y, window width, window height, window title, window flags, and fit type
BBJasperViewerWindow(BBjVector p_reports!) Constructs a BBJasperViewerWindow given a BBjVector of BBJasperReport objects
BBJasperViewerWindow(BBjVector p_reports!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_title!, BBjString p_flags$) Constructs a BBJasperViewerWindow given a BBjVector of BBJasperReport objects, window x, window y, window width, window height, window title, and window flags
BBJasperViewerWindow(BBjVector p_reports!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_title!, BBjString p_flags$, BBjNumber p_fitType) Constructs a BBJasperViewerWindow given a BBjVector of BBJasperReport objects, window x, window y, window width, window height, window title, window flags, and fit type
BBJasperViewerWindow(BBjVector p_reports!, BBjString p_title!) Constructs a BBJasperViewerWindow given a BBjVector of BBJasperReport objects and a window title
BBJasperViewerWindow(BBjVector p_reports!, BBjString p_title!, BBjString p_flags$) Constructs a BBJasperViewerWindow given a BBjVector of BBJasperReport objects, window title, and window flags
BBJasperViewerWindow(JasperPrint p_jasperPrint!) Constructs a BBJasperViewerWindow given a JasperPrint object
BBJasperViewerWindow(JasperPrint p_jasperPrint!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_title!, BBjString p_flags$) Constructs a BBJasperViewerWindow given a JasperPrint object, window X, window Y, window width, window height, window title, and window flags
BBJasperViewerWindow(JasperPrint p_jasperPrint!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_title!, BBjString p_flags$, BBjNumber p_fitType) Constructs a BBJasperViewerWindow given a JasperPrint object, window X, window Y, window width, window height, window title, window flags, and fit type
BBJasperViewerWindow(JasperPrint p_jasperPrint!, BBjString p_title!) Constructs a BBJasperViewerWindow given a JasperPrint object and a window title
BBJasperViewerWindow(JasperPrint p_jasperPrint!, BBjString p_title!, BBjString p_flags$) Constructs a BBJasperViewerWindow given a JasperPrint object, window title, and window flags

Method Summary

Modifier and Type	Method and Description
void	center() Centers the viewer window on either the MDI window or client desktop
void	destroy() Removes self from any parent viewer control, then destroys the viewer control and the viewer window
BBJasperViewerControl	getViewerControl() Returns the viewer control
BBjTopLevelWindow	getViewerWindow() Returns the viewer window
BBjString	getWindowTitle() Returns the title of the viewer window
void	OnClose(BBjSysGuiEvent p_event!) Called when the window is closed by the user
void	OnScreenResize(BBjScreenResizeEvent p_event!) Called when the screen is resized by the user
void	OnScreenResizeTimer(BBjTimerEvent p_event!) Called when the screen resize timer is triggered
void	OnWindowResize(BBjResizeEvent p_event!) Called when the window is resized by the user
void	OnWindowResizeTimer(BBjTimerEvent p_event!) Called when the window resize timer is triggered
static BBjNumber	setDefaults() Sets the default X, Y, width, height for the window
void	setSize(BBjNumber p_width, BBjNumber p_height) Sets the size of the viewer window and control
void	setWindowTitle(BBjString p_windowTitle!) Sets the title of the viewer window
void	show(BBjNumber p_processEvents) Shows the viewer window for non empty reports, and optionally process events for the window
void	show(BBjNumber p_processEvents, BBjNumber p_showEmpty) Shows the viewer window for empty or non empty reports, and optionally process events for the window

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ReleaseOnClose

public BBjNumber ReleaseOnClose

When set to TRUE (1), the interpreter running the viewer window will release when closed by the user

ParentViewerControl!

public BBJasperViewerControl ParentViewerControl!

The parent BBJasperViewerControl

WINDOW_ERROR

public static BBjNumber WINDOW_ERROR

Constant which represents that an error occured in the window

VIEWER_WINDOW_NAME$

public static BBjString VIEWER_WINDOW_NAME$

Constant which represents the viewer window name

Constructor Detail

BBJasperViewerWindow

public BBJasperViewerWindow(BBJasperReport p_report!)

Constructs a BBJasperViewerWindow given a BBJasperReport object

Parameters:

p_report! - A BBJasperReport object

BBJasperViewerWindow

public BBJasperViewerWindow(BBjVector p_reports!)

Constructs a BBJasperViewerWindow given a BBjVector of BBJasperReport objects

Parameters:

p_reports! - BBjVector of BBJasperReport objects

Since:

16.0

BBJasperViewerWindow

public BBJasperViewerWindow(BBJasperReport p_report!,
BBjString p_title!)

Constructs a BBJasperViewerWindow given a BBJasperReport object and a window title

Parameters:

p_report! - A BBJasperReport object

p_title! - Title for the window

BBJasperViewerWindow

public BBJasperViewerWindow(BBjVector p_reports!,
BBjString p_title!)

Constructs a BBJasperViewerWindow given a BBjVector of BBJasperReport objects and a window title

Parameters:

p_reports! - BBjVector of BBJasperReport objects

p_title! - Title for the window

Since:

16.0

BBJasperViewerWindow

public BBJasperViewerWindow(BBJasperReport p_report!,
BBjString p_title!,
BBjString p_flags$)

Constructs a BBJasperViewerWindow given a BBJasperReport object, window title, and window flags

Parameters:

p_report! - A BBJasperReport object

p_title! - Title for the window

p_flags$ - Flags for the window

BBJasperViewerWindow

public BBJasperViewerWindow(BBjVector p_reports!,
BBjString p_title!,
BBjString p_flags$)

Constructs a BBJasperViewerWindow given a BBjVector of BBJasperReport objects, window title, and window flags

Parameters:

p_reports! - BBjVector of BBJasperReport objects

p_title! - Title for the window

p_flags$ - Flags for the window

Since:

16.0

BBJasperViewerWindow

public BBJasperViewerWindow(BBJasperReport p_report!,
BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjString p_title!,
BBjString p_flags$)

Constructs a BBJasperViewerWindow given a BBJasperReport object, window x, window y, window width, window height, window title, and window flags

Parameters:

p_report! - A BBJasperReport object

p_x - X location for the window

p_y - Y location for the window

p_width - Width of the window

p_height - Height of the window

p_title! - Title for the window

p_flags$ - Flags for the window

BBJasperViewerWindow

public BBJasperViewerWindow(BBjVector p_reports!,
BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjString p_title!,
BBjString p_flags$)

Constructs a BBJasperViewerWindow given a BBjVector of BBJasperReport objects, window x, window y, window width, window height, window title, and window flags

Parameters:

p_reports! - BBjVector of BBJasperReport objects

p_x - X location for the window

p_y - Y location for the window

p_width - Width of the window

p_height - Height of the window

p_title! - Title for the window

p_flags$ - Flags for the window

Since:

16.0

BBJasperViewerWindow

public BBJasperViewerWindow(BBJasperReport p_report!,
BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjString p_title!,
BBjString p_flags$,
BBjNumber p_fitType)

Constructs a BBJasperViewerWindow given a BBJasperReport object, window x, window y, window width, window height, window title, window flags, and fit type

Parameters:

p_report! - A BBJasperReport object

p_x - X location for the window

p_y - Y location for the window

p_width - Width of the window

p_height - Height of the window

p_title! - Title for the window

p_flags$ - Flags for the window

p_fitType - Specifies on the following fit types: FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE

BBJasperViewerWindow

public BBJasperViewerWindow(BBjVector p_reports!,
BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjString p_title!,
BBjString p_flags$,
BBjNumber p_fitType)

Constructs a BBJasperViewerWindow given a BBjVector of BBJasperReport objects, window x, window y, window width, window height, window title, window flags, and fit type

Parameters:

p_reports! - BBjVector containing BBJasperReport objects

p_x - X location for the window

p_y - Y location for the window

p_width - Width of the window

p_height - Height of the window

p_title! - Title for the window

p_flags$ - Flags for the window

p_fitType - Specifies on the following fit types: FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE

Since:

16.0

BBJasperViewerWindow

public BBJasperViewerWindow(BBJasperViewerControl p_parentViewerControl!,
BBJasperReport p_report!,
BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjString p_title!,
BBjString p_flags$,
BBjNumber p_fitType)

Constructs a BBJasperViewerWindow given a parent BBJasperViewercontrol object, BBJasperReport object, window x, window y, window width, window height, window title, and window flags

Parameters:

p_parentViewerControl! - Specifies the parent BBJasperViewerControl object

p_report! - A BBJasperReport object

p_x - X location for the window

p_y - Y location for the window

p_width - Width of the window

p_height - Height of the window

p_title! - Title for the window

p_flags$ - Flags for the window

p_fitType - Specifies on the following fit types: FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE

BBJasperViewerWindow

public BBJasperViewerWindow(BBJasperViewerControl p_parentViewerControl!,
BBjVector p_reports!,
BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjString p_title!,
BBjString p_flags$,
BBjNumber p_fitType)

Constructs a BBJasperViewerWindow given a parent BBJasperViewercontrol object, BBJasperReport object, window x, window y, window width, window height, window title, and window flags

Parameters:

p_parentViewerControl! - Specifies the parent BBJasperViewerControl object

p_reports! - BBjVector of BBJasperReport objects

p_x - X location for the window

p_y - Y location for the window

p_width - Width of the window

p_height - Height of the window

p_title! - Title for the window

p_flags$ - Flags for the window

p_fitType - Specifies on the following fit types: FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE

Since:

16.0

BBJasperViewerWindow

public BBJasperViewerWindow(JasperPrint p_jasperPrint!)

Constructs a BBJasperViewerWindow given a JasperPrint object

Parameters:

p_jasperPrint! - A JasperPrint object

Since:

12.0

BBJasperViewerWindow

public BBJasperViewerWindow(JasperPrint p_jasperPrint!,
BBjString p_title!)

Constructs a BBJasperViewerWindow given a JasperPrint object and a window title

Parameters:

p_jasperPrint! - A JasperPrint object

p_title! - Title for the window

Since:

12.0

BBJasperViewerWindow

public BBJasperViewerWindow(JasperPrint p_jasperPrint!,
BBjString p_title!,
BBjString p_flags$)

Constructs a BBJasperViewerWindow given a JasperPrint object, window title, and window flags

Parameters:

p_jasperPrint! - A JasperPrint object

p_title! - Title for the window

p_flags$ - Flags for the window

Since:

12.0

BBJasperViewerWindow

public BBJasperViewerWindow(JasperPrint p_jasperPrint!,
BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjString p_title!,
BBjString p_flags$)

Constructs a BBJasperViewerWindow given a JasperPrint object, window X, window Y, window width, window height, window title, and window flags

Parameters:

p_jasperPrint! - A JasperPrint object

p_x - X location for the window

p_y - Y location for the window

p_width - Width of the window

p_height - Height of the window

p_title! - Title for the window

p_flags$ - Flags for the window

Since:

12.0

BBJasperViewerWindow

public BBJasperViewerWindow(JasperPrint p_jasperPrint!,
BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjString p_title!,
BBjString p_flags$,
BBjNumber p_fitType)

Constructs a BBJasperViewerWindow given a JasperPrint object, window X, window Y, window width, window height, window title, window flags, and fit type

Parameters:

p_jasperPrint! - A JasperPrint object

p_x - X location for the window

p_y - Y location for the window

p_width - Width of the window

p_height - Height of the window

p_title! - Title for the window

p_flags$ - Flags for the window

p_fitType - Specifies on the following fit types: FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE

Since:

12.0

BBJasperViewerWindow

public BBJasperViewerWindow(BBJasperViewerControl p_parentViewerControl!,
JasperPrint p_jasperPrint!,
BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjString p_title!,
BBjString p_flags$,
BBjNumber p_fitType)

Constructs a BBJasperViewerWindow given a parent JasperViewerControl object, JasperPrint object, window X, window Y, window width, window height, window title, window flags, and fit type

Parameters:

p_parentViewerControl! - Specifies the parent BBJasperViewerControl object

p_jasperPrint! - A JasperPrint object

p_x - X location for the window

p_y - Y location for the window

p_width - Width of the window

p_height - Height of the window

p_title! - Title for the window

p_flags$ - Flags for the window

p_fitType - Specifies on the following fit types: FIT_TYPE_ACTUAL, FIT_TYPE_WIDTH, FIT_TYPE_PAGE

Since:

12.0

Method Detail

setDefaults

public static BBjNumber setDefaults()

Sets the default X, Y, width, height for the window

show

public void show(BBjNumber p_processEvents)

Shows the viewer window for non empty reports, and optionally process events for the window

Parameters:

p_processEvents - Specify TRUE to process events for the window, otherwise FALSE

show

public void show(BBjNumber p_processEvents,
BBjNumber p_showEmpty)

Shows the viewer window for empty or non empty reports, and optionally process events for the window

Parameters:

p_processEvents - Specify TRUE to process events for the window, otherwise FALSE

p_showEmpty - Specify TRUE to show empty reports, otherwise FALSE

OnClose

public void OnClose(BBjSysGuiEvent p_event!)

Called when the window is closed by the user

Parameters:

p_event! - BBjSysGuiEvent object

OnWindowResize

public void OnWindowResize(BBjResizeEvent p_event!)

Called when the window is resized by the user

Parameters:

p_event! - BBjResizeEvent object

OnWindowResizeTimer

public void OnWindowResizeTimer(BBjTimerEvent p_event!)

Called when the window resize timer is triggered

Parameters:

p_event! - BBjTimerEvent object

OnScreenResize

public void OnScreenResize(BBjScreenResizeEvent p_event!)

Called when the screen is resized by the user

Parameters:

p_event! - BBjScreenResizeEvent object

OnScreenResizeTimer

public void OnScreenResizeTimer(BBjTimerEvent p_event!)

Called when the screen resize timer is triggered

Parameters:

p_event! - BBjTimerEvent object

setSize

public void setSize(BBjNumber p_width,
BBjNumber p_height)

Sets the size of the viewer window and control

Parameters:

p_width - Window width

p_height - Window height

setWindowTitle

public void setWindowTitle(BBjString p_windowTitle!)

Sets the title of the viewer window

Parameters:

p_windowTitle$ - Window title

getWindowTitle

public BBjString getWindowTitle()

Returns the title of the viewer window

Returns:

The title of the viewer window

destroy

public void destroy()

Removes self from any parent viewer control, then destroys the viewer control and the viewer window

center

public void center()

Centers the viewer window on either the MDI window or client desktop

getViewerWindow

public BBjTopLevelWindow getViewerWindow()

Returns the viewer window

Returns:

BBjTopLevelWindow object that is the viewer window

getViewerControl

public BBJasperViewerControl getViewerControl()

Returns the viewer control

Returns:

BBJasperViewerControl object associated with the viewer window