Dashboard

Class DashboardWidgetControl

java.lang.Object

Dashboard.WidgetControl

Dashboard.DashboardWidgetControl

public class DashboardWidgetControl
extends WidgetControl

UI class that displays a dashboard widget

Field Summary

Fields inherited from class Dashboard.WidgetControl

CloseButton!, DASHBOARD_WIDGET_AUTO_REFRESH_CONFIG_NAME$, DASHBOARD_WIDGET_AUTO_REFRESH_DONE_BUTTON_NAME$, DASHBOARD_WIDGET_AUTO_REFRESH_NAME$, DASHBOARD_WIDGET_AUTO_REFRESH_RATE_NAME$, DASHBOARD_WIDGET_AUTO_REFRESH_TEXT_NAME$, DASHBOARD_WIDGET_AUTO_REFRESH_UNITS_NAME$, DASHBOARD_WIDGET_AUTO_REFRESH_WINDOW_NAME$, DASHBOARD_WIDGET_CLOSE_BUTTON_NAME$, DASHBOARD_WIDGET_DECORATION_WINDOW_NAME$, DASHBOARD_WIDGET_MANUAL_REFRESH_NAME$, DASHBOARD_WIDGET_OPTIONS_BUTTON_NAME$, DASHBOARD_WIDGET_POPOUT_BUTTON_NAME$, DASHBOARD_WIDGET_REFRESH_MENU_NAME$, DASHBOARD_WIDGET_TITLE_BAR_NAME$, DASHBOARD_WIDGET_TITLE_TEXT_NAME$, DASHBOARD_WIDGET_WINDOW_NAME$, DraggingEnabled, MoveParentWindow, SelectEnabled, WidgetWindowX, WidgetWindowY

Constructor Summary

Constructors

Constructor and Description
DashboardWidgetControl(DashboardCategoryControl p_dashboardCategoryControl!, DashboardWidget p_dashboardWidget!, BBjWindow p_parentWindow!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_flags$) Contructs a dashboard widget control

Method Summary

Modifier and Type	Method and Description
void	activate(BBjNumber p_activate) Activates/Deactivates the dashboard widget control
void	destroy() Destroys the dashboard widget control
DashboardCategoryControl	getDashboardCategoryControl() Returns the dashboard category control that the dashboard widget control is housed in
void	OnMouseUp(BBjMouseUpEvent p_event!) Called when mouse is released on the dashboard widget control
void	OnPopout(BBjToolButtonPushEvent p_event!) Called popout button is pressed on the dashboard widget control
void	OnPopoutClose(BBjToolButtonPushEvent p_event!) Called when the popout window close button is pressed

Methods inherited from class Dashboard.WidgetControl

addFilter, addLink, getAutoRefreshEnabled, getAutoRefreshRate, getAutoRefreshUnit, getBackColor, getBBjControl, getDashboardWidget, getHeight, getName, getParentWindow, getPreviewImage, getScreenX, getScreenY, getTitle, getWidget, getWidth, getX, getY, isActive, isAutoRefreshConfigurationMenuItemEnabled, isAutoRefreshMenuItemEnabled, isCloseButtonEnabled, isDestroyed, isDraggingEnabled, isEmailMenuItemEnabled, isExportDataMenuItemEnabled, isManualRefreshMenuItemEnabled, isOptionsButtonEnabled, isPopoutButtonEnabled, isRefreshMenuEnabled, isRefreshMenuItemEnabled, isSaveMenuItemEnabled, isSelectEnabled, isViewDataMenuItemEnabled, OnAutoRefresh, OnAutoRefreshClose, OnAutoRefreshConfiguration, OnAutoRefreshDone, OnAutoRefreshTimer, OnClose, OnDashboardWidgetMenuItemSelect, OnEmail, OnExportData, OnFilterSelect, OnJasperViewerMouseClick, OnLinkToolButton, OnManualRefresh, OnMouseDown, OnMouseMove, OnOptions, OnPopoutWindowClose, OnPopoutWindowResize, OnRefresh, OnSave, OnViewData, OnWidgetControlMouseUp, OnWidgetControlPopup, popoutWindowResizeTimerEvent, refresh, refresh, refreshView, setActive, setAutoRefreshConfigurationMenuItemEnabled, setAutoRefreshEnabled, setAutoRefreshMenuItemEnabled, setAutoRefreshRate, setAutoRefreshUnit, setBackColor, setClickCallback, setCloseButtonEnabled, setDraggingEnabled, setEmailMenuItemEnabled, setExportDataMenuItemEnabled, setLeftClickCallback, setLocation, setManualRefreshMenuItemEnabled, setOptionsButtonEnabled, setPopoutButtonEnabled, setPreviewImage, setRefreshCallback, setRefreshConfigurationMenuEnabled, setRefreshMenuItemEnabled, setRightClickCallback, setSaveMenuItemEnabled, setSelectCallback, setSelected, setSelectEnabled, setSize, setTitle, setViewDataMenuItemEnabled, setVisible

Methods inherited from class java.lang.Object

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

Constructor Detail

DashboardWidgetControl

public DashboardWidgetControl(DashboardCategoryControl p_dashboardCategoryControl!,
DashboardWidget p_dashboardWidget!,
BBjWindow p_parentWindow!,
BBjNumber p_x,
BBjNumber p_y,
BBjNumber p_width,
BBjNumber p_height,
BBjString p_flags$)

Contructs a dashboard widget control

Parameters:

p_dashboardCategoryControl! - Dashboard category control that this control will be a part of

p_dashboardWidget! - Dashboard widget to display in the widget control

p_parentWindow! - Parent window of the widget control

p_x - X location of the widget control

p_y - Y location of the widget control

p_width - Width of the widget control

p_height - Height of the widget control

p_flags$ - Flags that control the appearance and behavior of the widget control

See Also:

BBjWindow::addChildWindow for the list of valid flag options

Method Detail

OnPopout

public void OnPopout(BBjToolButtonPushEvent p_event!)

Called popout button is pressed on the dashboard widget control

Overrides:

OnPopout in class WidgetControl

Parameters:

p_event! - BBjToolButtonPushEvent that contains event information

OnPopoutClose

public void OnPopoutClose(BBjToolButtonPushEvent p_event!)

Called when the popout window close button is pressed

Overrides:

OnPopoutClose in class WidgetControl

Parameters:

p_event! - BBjToolButtonPushEvent that contains event information

OnMouseUp

public void OnMouseUp(BBjMouseUpEvent p_event!)

Called when mouse is released on the dashboard widget control

Overrides:

OnMouseUp in class WidgetControl

Parameters:

p_event! - BBjMouseUpEvent that contains event information

activate

public void activate(BBjNumber p_activate)

Activates/Deactivates the dashboard widget control

Overrides:

activate in class WidgetControl

Parameters:

p_activate - Active status, 0 = inactive, 1 = active

getDashboardCategoryControl

public DashboardCategoryControl getDashboardCategoryControl()

Returns the dashboard category control that the dashboard widget control is housed in

Parameters:

DashboardCategoryControl - that the dashboard widget control is housed in

destroy

public void destroy()

Destroys the dashboard widget control

Overrides:

destroy in class WidgetControl