Dashboard

Interface Widget

All Known Implementing Classes:

AreaChartWidget, BarChartWidget, BaseWidget, BBjWidget, ChartWidget, GridExWidget, GridWidget, HtmlViewWidget, ImageWidget, JasperViewerWidget, LineChartWidget, PieChartWidget, RingChartWidget, StackedAreaChartWidget, StackedBarChartWidget, StackedPercentageBarChartWidget, XYChartWidget

public interface Widget

Interface that comprises all the functionality required to be a widget

Method Summary

Modifier and Type	Method and Description
Widget	clone() Creates and returns a clone of the widget
void	create(BBjChildWindow p_widgetControlWindow!) Called to create the widget
void	destroy() Destroys the widget
void	display(BBjNumber p_display) Called to display or hide the widget
BBjNumber	isDestroyed() Called to determine if the widget is destroyed
BBjString	name() Returns the unique name of the widget
BBjImage	previewImage() Returns the preview image of the widget
BBjString	previewText() Returns the preview text of the widget
void	resize(BBjNumber p_width, BBjNumber p_height) Resizes the widget using the provided with and height
BBjString	title() Returns the title of the widget

Method Detail

name

BBjString name()

Returns the unique name of the widget

Returns:

Unique name of the widget

title

BBjString title()

Returns the title of the widget

Returns:

Title of the widget

create

void create(BBjChildWindow p_widgetControlWindow!)

Called to create the widget

Parameters:

p_widgetControlWindow! - BBjChildWindow that will house the widget

previewText

BBjString previewText()

Returns the preview text of the widget

Returns:

Preview text of the widget

previewImage

BBjImage previewImage()

Returns the preview image of the widget

Returns:

BBjImage that contains the preview image image of the widget

display

void display(BBjNumber p_display)

Called to display or hide the widget

Parameters:

p_display - Indicates if the widget should be displayed. 0 = Not Displayed, 1 = Display

resize

void resize(BBjNumber p_width,
BBjNumber p_height)

Resizes the widget using the provided with and height

Parameters:

p_width - Width of the widget

p_height - Height of the widget

clone

Widget clone()

Creates and returns a clone of the widget

Returns:

Widget clone of the widget

destroy

void destroy()

Destroys the widget

isDestroyed

BBjNumber isDestroyed()

Called to determine if the widget is destroyed