WidgetControl

```
public class WidgetControl
```
WidgetControl UI class that displays a widget

See Also:
[]

Field Summary

Fields
Modifier and Type	Field and Description
`BBjToolButton`	`CloseButton!` Button in the in the widget control's titlebar that closes the widget control
`static BBjString`	`DASHBOARD_WIDGET_AUTO_REFRESH_CONFIG_NAME$` Auto refresh config menu name
`static BBjString`	`DASHBOARD_WIDGET_AUTO_REFRESH_DONE_BUTTON_NAME$` Auto refresh done button name
`static BBjString`	`DASHBOARD_WIDGET_AUTO_REFRESH_NAME$` Auto refresh menu item name
`static BBjString`	`DASHBOARD_WIDGET_AUTO_REFRESH_RATE_NAME$` Auto refresh rate name
`static BBjString`	`DASHBOARD_WIDGET_AUTO_REFRESH_TEXT_NAME$` Auto refresh text name
`static BBjString`	`DASHBOARD_WIDGET_AUTO_REFRESH_UNITS_NAME$` Auto refresh units name
`static BBjString`	`DASHBOARD_WIDGET_AUTO_REFRESH_WINDOW_NAME$` Auto refresh window name
`static BBjString`	`DASHBOARD_WIDGET_CLOSE_BUTTON_NAME$` Widget close button name
`static BBjString`	`DASHBOARD_WIDGET_DECORATION_WINDOW_NAME$` Widget decoration window name
`static BBjString`	`DASHBOARD_WIDGET_MANUAL_REFRESH_NAME$` Manual refresh menu item name
`static BBjString`	`DASHBOARD_WIDGET_OPTIONS_BUTTON_NAME$` Widget options button name
`static BBjString`	`DASHBOARD_WIDGET_POPOUT_BUTTON_NAME$` Widget popout button name
`static BBjString`	`DASHBOARD_WIDGET_REFRESH_MENU_NAME$` Refresh menu name
`static BBjString`	`DASHBOARD_WIDGET_TITLE_BAR_NAME$` Widget title bar name
`static BBjString`	`DASHBOARD_WIDGET_TITLE_TEXT_NAME$` Widget title text name
`static BBjString`	`DASHBOARD_WIDGET_WINDOW_NAME$` Widget window name
`BBjNumber`	`DraggingEnabled=1` Indicates if dragging is enabled for the widget control
`BBjNumber`	`MoveParentWindow=0` Indicates if the parent window that houses the widget control should be dragged when the widget control is dragged
`BBjNumber`	`SelectEnabled=1` Indicates if the widget control is selectable
`BBjNumber`	`WidgetWindowX` X location of the window that houses the widget control
`BBjNumber`	`WidgetWindowY` Y location of the window that houses the widget control

Constructor Summary

Constructors
Constructor and Description
`WidgetControl(DashboardWidget p_dashboardWidget!, BBjWindow p_parentWindow!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_flags$)` Contructs a widget control

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`activate(BBjNumber p_activate)` Activate or deactivates the widget control by setting its visibility and creating the Widget if necessary
`void`	`addFilter(DashboardWidgetFilter p_dashboardWidgetFilter!)` Adds a filter to the dashboard control to filter values
`void`	`addLink(DashboardWidgetLink p_dashboardWidgetLink!)` Adds a link that can be used to invoke a URL for the dashboard control
`void`	`destroy()` Destroys the widget control
`BBjNumber`	`getAutoRefreshEnabled()` Returns the auto refresh status
`BBjNumber`	`getAutoRefreshRate()` Returns the auto refresh rate
`BBjNumber`	`getAutoRefreshUnit()` Returns the auto refresh unit
`BBjColor`	`getBackColor()` Returns the background color of the widget control
`BBjControl`	`getBBjControl(BBjString p_controlName$)` Returns the BBjControl identified by the provided control name
`DashboardWidget`	`getDashboardWidget()` Returns the encapuslated dashboard widget used in the widget control
`BBjNumber`	`getHeight()` Returns the height of the widget control
`BBjString`	`getName()` Returns the name of the widget control
`BBjWindow`	`getParentWindow()` Returns the widget control's parent window which was specified during the construction of the WidgetControl
`BBjImage`	`getPreviewImage()` Returns the preview image for the widget control that is used for display in the customize dialog
`BBjNumber`	`getScreenX()` Returns the X location of the widget control on the screen
`BBjNumber`	`getScreenY()` Returns the Y location of the widget control on the screen
`BBjString`	`getTitle()` Returns the title of the widget control
`Widget`	`getWidget()` Returns the encapuslated widget used in the widget control
`BBjNumber`	`getWidth()` Returns the width of the widget control
`BBjNumber`	`getX()` Returns the X location of the widget control
`BBjNumber`	`getY()` Returns the Y location of the widget control
`BBjNumber`	`isActive()` Returns the active status of the widget control
`BBjNumber`	`isAutoRefreshConfigurationMenuItemEnabled()` Returns the enable status of the auto refresh configuration menu item in the options menu
`BBjNumber`	`isAutoRefreshMenuItemEnabled()` Returns the enable status of the auto refresh menu item in the options menu
`BBjNumber`	`isCloseButtonEnabled()` Returns the enable status of the close button in the widget control
`BBjNumber`	`isDestroyed()` Returns if the widget control is destroyed
`BBjNumber`	`isDraggingEnabled()` Returns the dragging enable status of the widget control
`BBjNumber`	`isEmailMenuItemEnabled()` Returns the enable status of the email menu item in the options menu
`BBjNumber`	`isExportDataMenuItemEnabled()` Returns the enable status of the export data menu item in the options menu
`BBjNumber`	`isManualRefreshMenuItemEnabled()` Returns the enable status of the manual refresh menu item in the options menu
`BBjNumber`	`isOptionsButtonEnabled()` Returns the enable status of the options button in the widget control
`BBjNumber`	`isPopoutButtonEnabled()` Returns the enable status of the popout button in the widget control
`BBjNumber`	`isRefreshMenuEnabled()` Returns the enable status of the refresh menu in the options menu
`BBjNumber`	`isRefreshMenuItemEnabled()` Returns the enable status of the refresh menu item in the options menu
`BBjNumber`	`isSaveMenuItemEnabled()` Returns the enable status of the save menu item in the options menu
`BBjNumber`	`isSelectEnabled()` Returns the selectability of the widget control
`BBjNumber`	`isViewDataMenuItemEnabled()` Returns the enable status of the view data menu item in the options menu
`void`	`OnAutoRefresh(BBjPopupSelectEvent p_event!)` An internal method used by the WidgetControl that is called when the auto refresh menu item is selected
`void`	`OnAutoRefreshClose(BBjCloseEvent p_event!)` An internal method used by the WidgetControl that is called when the auto refresh configuration window close is selected
`void`	`OnAutoRefreshConfiguration(BBjPopupSelectEvent p_event!)` An internal method used by the WidgetControl that is called when the auto refresh configuratoin menu item is selected
`void`	`OnAutoRefreshDone(BBjToolButtonPushEvent p_event!)` An internal method used by the WidgetControl that is called when the auto refresh configuration window close is selected
`void`	`OnAutoRefreshTimer(BBjTimerEvent p_event!)` An internal method used by the WidgetControl that is called when the auto refresh timer is fired. As of BBj 18.20 this event only applies to active widgets. A widget that is hidden will not refresh until it is activated again.
`void`	`OnClose(BBjToolButtonPushEvent p_event!)` An internal method used by the WidgetControl that is called when the user deactivates the widget by pressing the close button on the widget control
`void`	`OnDashboardWidgetMenuItemSelect(BBjPopupSelectEvent p_event!)` An internal method used by the WidgetControl that is called when the user selects a menu item from a custom DashboardWidgetMenu This routine responds to the user selecting a menu item from a custom DashboardWidgetMenu, creates the relevant DashboardWidgetMenuSelectEvent object, then posts the custom event so that the developer's callback routine executes in response to the DashboardWidgetMenuSelectEvent.
`void`	`OnEmail(BBjPopupSelectEvent p_event!)` Called when the email popup menu item is selected on the widget control
`void`	`OnExportData(BBjPopupSelectEvent p_event!)` Called when the export data popup menu item is selected on the widget control
`void`	`OnFilterSelect(BBjEvent p_event!)` An internal method used by the WidgetControl that is called when the a filter list item is selected in a filter on the widget control This routine responds to the user selecting an item from a custom DashboardWidgetFilter, creates the relevant DashboardWidgetFilterSelectEvent object, then posts the custom event so that the developer's callback routine executes in response to the DashboardWidgetFilterSelectEvent.
`void`	`OnJasperViewerMouseClick(BBjCustomEvent p_event!)` Called when the mouse is clicked in a Jasper Viewer
`void`	`OnLinkToolButton(BBjToolButtonPushEvent p_event!)` An internal method used by the WidgetControl that is called when a link is selected to invoke a URL for the widget control This routine responds to the user clicking a DashboardWidgetLink, creates the relevant DashboardWidgetLinkSelectEvent object, then posts the custom event so that the developer's callback routine executes in response to the DashboardWidgetLinkSelectEvent. In GUI, this routine executes a BBjThinClient::browse() to launch the link if the DashboardWidgetLink's BrowseOnSelect parameter is true. In BUI, the link is created with an anchor tag that has a target='_blank' attribute to open the link in a new tab instead of a popup browser window.
`void`	`OnManualRefresh(BBjPopupSelectEvent p_event!)` An internal method used by the WidgetControl that is called when the manual refresh menu item is selected
`void`	`OnMouseDown(BBjMouseDownEvent p_event!)` An internal method used by the WidgetControl that is called when the mouse is pressed down in the widget control. The OnMouse* events are used specifically for draggging and rearranging DashboardWidgets.
`void`	`OnMouseMove(BBjMouseMoveEvent p_event!)` An internal method used by the WidgetControl that is called when the mouse is moved in the widget control. The OnMouse* events are used specifically for draggging and rearranging DashboardWidgets.
`void`	`OnMouseUp(BBjMouseUpEvent p_event!)` An internal method used by the WidgetControl that is called when the mouse is released in the widget control. The OnMouse* events are used specifically for draggging and rearranging DashboardWidgets.
`void`	`OnOptions(BBjToolButtonPushEvent p_event!)` An internal method used by the WidgetControl that is called when the Options tool button is pushed on the widget control
`void`	`OnPopout(BBjToolButtonPushEvent p_event!)` An internal method used by the WidgetControl in response to the widget's popout button press event
`void`	`OnPopoutClose(BBjToolButtonPushEvent p_event!)` An internal method used by the WidgetControl in response to the popout window's close button's pressed event
`void`	`OnPopoutWindowClose(BBjCloseEvent p_event!)` An internal method used by the WidgetControl in response to the popout window's close event
`void`	`OnPopoutWindowResize(BBjResizeEvent p_event!)` An internal method used by the WidgetControl in response to the popout window's resize event
`void`	`OnRefresh(BBjPopupSelectEvent p_event!)` Called when the refresh popup menu item is selected on the widget control
`void`	`OnSave(BBjPopupSelectEvent p_event!)` Called when the save popup menu item is selected on the widget control
`void`	`OnViewData(BBjPopupSelectEvent p_event!)` Called when the view data popup menu item is selected on the widget control
`void`	`OnWidgetControlMouseUp(BBjMouseUpEvent p_event!)` An internal method used by the WidgetControl that is called when the user presses a mouse key down and then releases it over the widget window This routine responds to the mouse click and will either post custom events if the developer has registered for click events, or will execute default behavior based on which mouse button was pressed. By default, a left click adds a tooltip to the interior chart widget if the user clicked on a chart's data item, e.g. a bar in a bar chart or slice in a pie chart. By default, a right click displays the default popup Options menu which is also available by selecting a DashboardWidget's Options tool button. If the developer set callbacks for a DashboardWidgetClickEvent, DashboardWidgetLeftClickEvent, or DashboardWidgetRightClickEvent then the routine creates the relevant DashboardWidgetEvent(s) based on the registered events, then posts the custom event(s) so that the developer's callback routines execute in response to the mouse event.
`void`	`OnWidgetControlPopup(BBjPopupRequestEvent p_event!)` An internal method used by the WidgetControl that is called when the mouse is right-clicked over the widget window This method exists so that a custom popup menu will be displayed instead of the default browser's popup menu.
`void`	`popoutWindowResizeTimerEvent(BBjTimerEvent p_event!)` An internal method used by the WidgetControl to resize the window when the popout window's resize timer event fires
`void`	`refresh()` Refreshes the widget control
`void`	`refresh(BBjNumber p_refreshType)` Internal refresh routine that refreshes the widget control and sets the type of refresh based on what event initiated the event This routine responds to the WidgetControl's refresh event and will either pass the refresh request on to the interior widget or, if the developer has set a callback for the refresh event, it creates a DashboardWidgetRefreshEvent object then posts the custom event so that the developer's callback routine executes in response to the DashboardWidgetRefreshEvent.
`void`	`refreshView()` An internal method to refresh the widget control's links, filters, and inner widget This is the result of the developer's custom code calling the DashboardWidget.refresh() method
`void`	`setActive(BBjNumber p_active)` Sets the active status of the widget control by setting the associated DashboardWidget's active flag
`void`	`setAutoRefreshConfigurationMenuItemEnabled(BBjNumber p_enable)` Sets the enable status of the auto refresh configuration menu item in the options menu
`void`	`setAutoRefreshEnabled(BBjNumber p_autoRefreshEnabled)` Sets the auto refresh enabled or disabled
`void`	`setAutoRefreshMenuItemEnabled(BBjNumber p_enable)` Sets the enable status of the auto refresh menu item in the options menu
`void`	`setAutoRefreshRate(BBjNumber p_rate)` Sets the auto refresh rate
`void`	`setAutoRefreshUnit(BBjNumber p_unit)` Sets the auto refresh unit
`void`	`setBackColor(BBjColor p_backColor!)` Sets the background color of the widget control
`void`	`setClickCallback(DashboardWidget p_dashboardWidget!)` Sets a callback for a left click event that occurs on the passed dashboard widget
`void`	`setCloseButtonEnabled(BBjNumber p_enable)` Sets the enable status of the close button in the widget control
`void`	`setDraggingEnabled(BBjNumber p_draggingEnabled)` Sets the dragging enable status of the widget control
`void`	`setEmailMenuItemEnabled(BBjNumber p_enable)` Sets the enable status of the email menu item in the options menu
`void`	`setExportDataMenuItemEnabled(BBjNumber p_enable)` Sets the enable status of the export data menu item in the options menu
`void`	`setLeftClickCallback(DashboardWidget p_dashboardWidget!)` Sets a callback for a left click event that occurs on the passed dashboard widget
`void`	`setLocation(BBjNumber p_x, BBjNumber p_y)` Sets the location of the widget control
`void`	`setManualRefreshMenuItemEnabled(BBjNumber p_enable)` Sets the enable status of the manual refresh menu item in the options menu
`void`	`setOptionsButtonEnabled(BBjNumber p_enable)` Sets the enable status of the options button in the widget control
`void`	`setPopoutButtonEnabled(BBjNumber p_enable)` Sets the enable status of the popout button in the widget control
`void`	`setPreviewImage(BBjImage p_previewImage!)` Sets the preview image for the widget control that will be displayed in the customize dialog
`void`	`setRefreshCallback(DashboardWidget p_dashboardWidget!)` Sets a callback for a refresh event that occurs on the passed dashboard widget
`void`	`setRefreshConfigurationMenuEnabled(BBjNumber p_enable)` Sets the enable status of the refresh configuration menu in the options menu
`void`	`setRefreshMenuItemEnabled(BBjNumber p_enable)` Sets the enable status of the refresh menu item in the options menu
`void`	`setRightClickCallback(DashboardWidget p_dashboardWidget!)` Sets a callback for a right click event that occurs on the passed dashboard widget
`void`	`setSaveMenuItemEnabled(BBjNumber p_enable)` Sets the enable status of the save menu item in the options menu
`void`	`setSelectCallback(DashboardWidget p_dashboardWidget!)` Sets a callback for a select event that occurs on the passed dashboard widget
`void`	`setSelected(BBjNumber p_selected)` Sets the widget's selected status. This modifies the widget's appearance by changing the titlebar color and setting a CSS selector on the control to distinguish it visually from the other, non-selected dashboard widgets.
`void`	`setSelectEnabled(BBjNumber p_selectEnabled)` Sets the selectability of the widget control
`void`	`setSize(BBjNumber p_width, BBjNumber p_height)` Sets the size of the widget control
`void`	`setTitle(BBjString p_title$)` Sets the title for the widget control
`void`	`setViewDataMenuItemEnabled(BBjNumber p_enable)` Sets the enable status of the view data menu item in the options menu
`void`	`setVisible(BBjNumber p_visible)` Sets the widget control's visibility

Field Detail
- CloseButton!
```
public BBjToolButton CloseButton!
```
  Button in the in the widget control's titlebar that closes the widget control
- DASHBOARD_WIDGET_AUTO_REFRESH_CONFIG_NAME$
```
public static BBjString DASHBOARD_WIDGET_AUTO_REFRESH_CONFIG_NAME$
```
  Auto refresh config menu name
- DASHBOARD_WIDGET_AUTO_REFRESH_DONE_BUTTON_NAME$
```
public static BBjString DASHBOARD_WIDGET_AUTO_REFRESH_DONE_BUTTON_NAME$
```
  Auto refresh done button name
- DASHBOARD_WIDGET_AUTO_REFRESH_NAME$
```
public static BBjString DASHBOARD_WIDGET_AUTO_REFRESH_NAME$
```
  Auto refresh menu item name
- DASHBOARD_WIDGET_AUTO_REFRESH_RATE_NAME$
```
public static BBjString DASHBOARD_WIDGET_AUTO_REFRESH_RATE_NAME$
```
  Auto refresh rate name
- DASHBOARD_WIDGET_AUTO_REFRESH_TEXT_NAME$
```
public static BBjString DASHBOARD_WIDGET_AUTO_REFRESH_TEXT_NAME$
```
  Auto refresh text name
- DASHBOARD_WIDGET_AUTO_REFRESH_UNITS_NAME$
```
public static BBjString DASHBOARD_WIDGET_AUTO_REFRESH_UNITS_NAME$
```
  Auto refresh units name
- DASHBOARD_WIDGET_AUTO_REFRESH_WINDOW_NAME$
```
public static BBjString DASHBOARD_WIDGET_AUTO_REFRESH_WINDOW_NAME$
```
  Auto refresh window name
- DASHBOARD_WIDGET_CLOSE_BUTTON_NAME$
```
public static BBjString DASHBOARD_WIDGET_CLOSE_BUTTON_NAME$
```
  Widget close button name
- DASHBOARD_WIDGET_DECORATION_WINDOW_NAME$
```
public static BBjString DASHBOARD_WIDGET_DECORATION_WINDOW_NAME$
```
  Widget decoration window name
- DASHBOARD_WIDGET_MANUAL_REFRESH_NAME$
```
public static BBjString DASHBOARD_WIDGET_MANUAL_REFRESH_NAME$
```
  Manual refresh menu item name
- DASHBOARD_WIDGET_OPTIONS_BUTTON_NAME$
```
public static BBjString DASHBOARD_WIDGET_OPTIONS_BUTTON_NAME$
```
  Widget options button name
- DASHBOARD_WIDGET_POPOUT_BUTTON_NAME$
```
public static BBjString DASHBOARD_WIDGET_POPOUT_BUTTON_NAME$
```
  Widget popout button name
- DASHBOARD_WIDGET_REFRESH_MENU_NAME$
```
public static BBjString DASHBOARD_WIDGET_REFRESH_MENU_NAME$
```
  Refresh menu name
- DASHBOARD_WIDGET_TITLE_BAR_NAME$
```
public static BBjString DASHBOARD_WIDGET_TITLE_BAR_NAME$
```
  Widget title bar name
- DASHBOARD_WIDGET_TITLE_TEXT_NAME$
```
public static BBjString DASHBOARD_WIDGET_TITLE_TEXT_NAME$
```
  Widget title text name
- DASHBOARD_WIDGET_WINDOW_NAME$
```
public static BBjString DASHBOARD_WIDGET_WINDOW_NAME$
```
  Widget window name
- DraggingEnabled=1
```
public BBjNumber DraggingEnabled=1
```
  Indicates if dragging is enabled for the widget control
- MoveParentWindow=0
```
public BBjNumber MoveParentWindow=0
```
  Indicates if the parent window that houses the widget control should be dragged when the widget control is dragged
- SelectEnabled=1
```
public BBjNumber SelectEnabled=1
```
  Indicates if the widget control is selectable
- WidgetWindowX
```
public BBjNumber WidgetWindowX
```
  X location of the window that houses the widget control
- WidgetWindowY
```
public BBjNumber WidgetWindowY
```
  Y location of the window that houses the widget control

Constructor Detail
- WidgetControl
```
public WidgetControl(DashboardWidget p_dashboardWidget!, BBjWindow p_parentWindow!, BBjNumber p_x, BBjNumber p_y, BBjNumber p_width, BBjNumber p_height, BBjString p_flags$)
```
  Contructs a widget control
  
  Parameters:
  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$ Window flags that control the appearance and behavior of the widget control's window
  See Also:
  BBjWindow::addChildWindow for the list of valid flag options

- Method Detail
  - activate
```
public void activate(BBjNumber p_activate)
```
    Activate or deactivates the widget control by setting its visibility and creating the Widget if necessary
    
    Parameters:
    p_activate Active status of the widget control, 0=inactive (hidden), 1=active (visible)
  - addFilter
```
public void addFilter(DashboardWidgetFilter p_dashboardWidgetFilter!)
```
    Adds a filter to the dashboard control to filter values
    
    Parameters:
    p_dashboardWidgetFilter! DashboardWidgetFilter that will be used to filter values for the widget control
  - addLink
```
public void addLink(DashboardWidgetLink p_dashboardWidgetLink!)
```
    Adds a link that can be used to invoke a URL for the dashboard control
    
    Parameters:
    p_dashboardWidgetLink! DashboardWidgetLink that will be used to invoke a URL for the dashboard control
  - destroy
```
public void destroy()
```
    Destroys the widget control
  - getAutoRefreshEnabled
```
public BBjNumber getAutoRefreshEnabled()
```
    Returns the auto refresh status
    
    Returns:
    Enable status of auto refresh. 0=disabled, 1=enabled
  - getAutoRefreshRate
```
public BBjNumber getAutoRefreshRate()
```
    Returns the auto refresh rate
    
    Returns:
    Rate of auto refresh interval.
  - getAutoRefreshUnit
```
public BBjNumber getAutoRefreshUnit()
```
    Returns the auto refresh unit
    
    Parameters:
    Unit for the auto refresh, valid values are AutoRefreshUnit.getSeconds(), AutoRefreshUnit.getMinutes(), AutoRefreshUnit.getHours()
  - getBackColor
```
public BBjColor getBackColor()
```
    Returns the background color of the widget control
    
    Parameters:
    BBjColor used for the background color of the widget control
  - getBBjControl
```
public BBjControl getBBjControl(BBjString p_controlName$)
```
    Returns the BBjControl identified by the provided control name
    
    Parameters:
    p_controlName$ Unique control name of the control to obtain
    Returns:
    BBjControl that is associated with provided in name, otherwise null()
  - getDashboardWidget
```
public DashboardWidget getDashboardWidget()
```
    Returns the encapuslated dashboard widget used in the widget control
    
    Returns:
    DashboardWidget encapsualted by the dashboard widget control otherwise null()
  - getHeight
```
public BBjNumber getHeight()
```
    Returns the height of the widget control
    
    Returns:
    Height of the widget control
  - getName
```
public BBjString getName()
```
    Returns the name of the widget control
    
    Returns:
    Name of the widget control
  - getParentWindow
```
public BBjWindow getParentWindow()
```
    Returns the widget control's parent window which was specified during the construction of the WidgetControl
    
    Returns:
    The parent window of the WidgetControl
    Since:
    BBj 18.10
  - getPreviewImage
```
public BBjImage getPreviewImage()
```
    Returns the preview image for the widget control that is used for display in the customize dialog
    
    Returns:
    BBjImage that is used as the preview image for the widget control which is displayed in the customize dialog
  - getScreenX
```
public BBjNumber getScreenX()
```
    Returns the X location of the widget control on the screen
    
    Returns:
    X coordinate of the widget control
    Since:
    BBj 18.10
  - getScreenY
```
public BBjNumber getScreenY()
```
    Returns the Y location of the widget control on the screen
    
    Returns:
    Y coordinate of the widget control
    Since:
    BBj 18.10
  - getTitle
```
public BBjString getTitle()
```
    Returns the title of the widget control
    
    Returns:
    Title of the widget control
  - getWidget
```
public Widget getWidget()
```
    Returns the encapuslated widget used in the widget control
    
    Returns:
    Widget encapsualted by the widget control otherwise null()
  - getWidth
```
public BBjNumber getWidth()
```
    Returns the width of the widget control
    
    Returns:
    Width of the widget control
  - getX
```
public BBjNumber getX()
```
    Returns the X location of the widget control
    
    Returns:
    X coordinate of the widget control
  - getY
```
public BBjNumber getY()
```
    Returns the Y location of the widget control
    
    Returns:
    Y coordinate of the widget control
  - isActive
```
public BBjNumber isActive()
```
    Returns the active status of the widget control
    
    Parameters:
    Active status of the widget control, 0=inactive, 1=active
  - isAutoRefreshConfigurationMenuItemEnabled
```
public BBjNumber isAutoRefreshConfigurationMenuItemEnabled()
```
    Returns the enable status of the auto refresh configuration menu item in the options menu
  - isAutoRefreshMenuItemEnabled
```
public BBjNumber isAutoRefreshMenuItemEnabled()
```
    Returns the enable status of the auto refresh menu item in the options menu
  - isCloseButtonEnabled
```
public BBjNumber isCloseButtonEnabled()
```
    Returns the enable status of the close button in the widget control
  - isDestroyed
```
public BBjNumber isDestroyed()
```
    Returns if the widget control is destroyed
    
    Returns:
    Returns 1 if destroyed, otherwise 0 is returned
  - isDraggingEnabled
```
public BBjNumber isDraggingEnabled()
```
    Returns the dragging enable status of the widget control
  - isEmailMenuItemEnabled
```
public BBjNumber isEmailMenuItemEnabled()
```
    Returns the enable status of the email menu item in the options menu
  - isExportDataMenuItemEnabled
```
public BBjNumber isExportDataMenuItemEnabled()
```
    Returns the enable status of the export data menu item in the options menu
  - isManualRefreshMenuItemEnabled
```
public BBjNumber isManualRefreshMenuItemEnabled()
```
    Returns the enable status of the manual refresh menu item in the options menu
  - isOptionsButtonEnabled
```
public BBjNumber isOptionsButtonEnabled()
```
    Returns the enable status of the options button in the widget control
  - isPopoutButtonEnabled
```
public BBjNumber isPopoutButtonEnabled()
```
    Returns the enable status of the popout button in the widget control
  - isRefreshMenuEnabled
```
public BBjNumber isRefreshMenuEnabled()
```
    Returns the enable status of the refresh menu in the options menu
  - isRefreshMenuItemEnabled
```
public BBjNumber isRefreshMenuItemEnabled()
```
    Returns the enable status of the refresh menu item in the options menu
  - isSaveMenuItemEnabled
```
public BBjNumber isSaveMenuItemEnabled()
```
    Returns the enable status of the save menu item in the options menu
  - isSelectEnabled
```
public BBjNumber isSelectEnabled()
```
    Returns the selectability of the widget control
  - isViewDataMenuItemEnabled
```
public BBjNumber isViewDataMenuItemEnabled()
```
    Returns the enable status of the view data menu item in the options menu
  - OnAutoRefresh
```
public void OnAutoRefresh(BBjPopupSelectEvent p_event!)
```
    An internal method used by the WidgetControl that is called when the auto refresh menu item is selected
    
    Parameters:
    p_event! BBjPopupSelectEvent that contains event information
  - OnAutoRefreshClose
```
public void OnAutoRefreshClose(BBjCloseEvent p_event!)
```
    An internal method used by the WidgetControl that is called when the auto refresh configuration window close is selected
    
    Parameters:
    p_event! BBjCloseEvent that contains event information
  - OnAutoRefreshConfiguration
```
public void OnAutoRefreshConfiguration(BBjPopupSelectEvent p_event!)
```
    An internal method used by the WidgetControl that is called when the auto refresh configuratoin menu item is selected
    
    Parameters:
    p_event! BBjPopupSelectEvent that contains event information
  - OnAutoRefreshDone
```
public void OnAutoRefreshDone(BBjToolButtonPushEvent p_event!)
```
    An internal method used by the WidgetControl that is called when the auto refresh configuration window close is selected
    
    Parameters:
    p_event! BBjCloseEvent that contains event information
  - OnAutoRefreshTimer
```
public void OnAutoRefreshTimer(BBjTimerEvent p_event!)
```
    An internal method used by the WidgetControl that is called when the auto refresh timer is fired. As of BBj 18.20 this event only applies to active widgets. A widget that is hidden will not refresh until it is activated again.
    
    Parameters:
    p_event! BBjTimerEvent that contains event information
  - OnClose
```
public void OnClose(BBjToolButtonPushEvent p_event!)
```
    An internal method used by the WidgetControl that is called when the user deactivates the widget by pressing the close button on the widget control
    
    Parameters:
    p_event! BBjToolButtonPushEvent that contains event information
  - OnDashboardWidgetMenuItemSelect
```
public void OnDashboardWidgetMenuItemSelect(BBjPopupSelectEvent p_event!)
```
    An internal method used by the WidgetControl that is called when the user selects a menu item from a custom DashboardWidgetMenu
    
    This routine responds to the user selecting a menu item from a custom DashboardWidgetMenu, creates the relevant DashboardWidgetMenuSelectEvent object, then posts the custom event so that the developer's callback routine executes in response to the DashboardWidgetMenuSelectEvent.
    Parameters:
    p_event! BBjPopupSelectEvent that contains event information
    Since:
    BBj 18.10
  - OnEmail
```
public void OnEmail(BBjPopupSelectEvent p_event!)
```
    Called when the email popup menu item is selected on the widget control
    
    Parameters:
    p_event! BBjPopupSelectEvent which contains event information
  - OnExportData
```
public void OnExportData(BBjPopupSelectEvent p_event!)
```
    Called when the export data popup menu item is selected on the widget control
    
    Parameters:
    p_event! BBjPopupSelectEvent which contains event information
  - OnFilterSelect
```
public void OnFilterSelect(BBjEvent p_event!)
```
    An internal method used by the WidgetControl that is called when the a filter list item is selected in a filter on the widget control
    
    This routine responds to the user selecting an item from a custom DashboardWidgetFilter, creates the relevant DashboardWidgetFilterSelectEvent object, then posts the custom event so that the developer's callback routine executes in response to the DashboardWidgetFilterSelectEvent.
    Parameters:
    p_event! BBjListSelectEvent which contains event information
  - OnJasperViewerMouseClick
```
public void OnJasperViewerMouseClick(BBjCustomEvent p_event!)
```
    Called when the mouse is clicked in a Jasper Viewer
    
    Parameters:
    p_event! BBjCustomEvent that contains event information
  - OnLinkToolButton
```
public void OnLinkToolButton(BBjToolButtonPushEvent p_event!)
```
    An internal method used by the WidgetControl that is called when a link is selected to invoke a URL for the widget control
    
    This routine responds to the user clicking a DashboardWidgetLink, creates the relevant DashboardWidgetLinkSelectEvent object, then posts the custom event so that the developer's callback routine executes in response to the DashboardWidgetLinkSelectEvent.
    In GUI, this routine executes a BBjThinClient::browse() to launch the link if the DashboardWidgetLink's BrowseOnSelect parameter is true. In BUI, the link is created with an anchor tag that has a target='_blank' attribute to open the link in a new tab instead of a popup browser window.
    Parameters:
    p_event! BBjToolButtonPushEvent that contains event information
  - OnManualRefresh
```
public void OnManualRefresh(BBjPopupSelectEvent p_event!)
```
    An internal method used by the WidgetControl that is called when the manual refresh menu item is selected
    
    Parameters:
    p_event! BBjPopupSelectEvent that contains event information
  - OnMouseDown
```
public void OnMouseDown(BBjMouseDownEvent p_event!)
```
    An internal method used by the WidgetControl that is called when the mouse is pressed down in the widget control. The OnMouse* events are used specifically for draggging and rearranging DashboardWidgets.
    
    Parameters:
    p_event! BBjMouseDownEvent that contains event information
  - OnMouseMove
```
public void OnMouseMove(BBjMouseMoveEvent p_event!)
```
    An internal method used by the WidgetControl that is called when the mouse is moved in the widget control. The OnMouse* events are used specifically for draggging and rearranging DashboardWidgets.
    
    Parameters:
    p_event! BBjMouseMoveEvent that contains event information
  - OnMouseUp
```
public void OnMouseUp(BBjMouseUpEvent p_event!)
```
    An internal method used by the WidgetControl that is called when the mouse is released in the widget control. The OnMouse* events are used specifically for draggging and rearranging DashboardWidgets.
    
    Parameters:
    p_event! BBjMouseUpEvent that contains event information
  - OnOptions
```
public void OnOptions(BBjToolButtonPushEvent p_event!)
```
    An internal method used by the WidgetControl that is called when the Options tool button is pushed on the widget control
    
    Parameters:
    p_event! BBjToolButtonPushEvent which contains event information
  - OnPopout
```
public void OnPopout(BBjToolButtonPushEvent p_event!)
```
    An internal method used by the WidgetControl in response to the widget's popout button press event
    
    Parameters:
    p_event! BBjToolButtonPushEvent that contains event information
  - OnPopoutClose
```
public void OnPopoutClose(BBjToolButtonPushEvent p_event!)
```
    An internal method used by the WidgetControl in response to the popout window's close button's pressed event
    
    Parameters:
    p_event! BBjToolButtonPushEvent that contains event information
  - OnPopoutWindowClose
```
public void OnPopoutWindowClose(BBjCloseEvent p_event!)
```
    An internal method used by the WidgetControl in response to the popout window's close event
    
    Parameters:
    p_event! BBjCloseEvent that contains event information
  - OnPopoutWindowResize
```
public void OnPopoutWindowResize(BBjResizeEvent p_event!)
```
    An internal method used by the WidgetControl in response to the popout window's resize event
    
    Parameters:
    p_event! BBjResizeEvent that contains event information
  - OnRefresh
```
public void OnRefresh(BBjPopupSelectEvent p_event!)
```
    Called when the refresh popup menu item is selected on the widget control
    
    Parameters:
    p_event! BBjPopupSelectEvent which contains event information
  - OnSave
```
public void OnSave(BBjPopupSelectEvent p_event!)
```
    Called when the save popup menu item is selected on the widget control
    
    Parameters:
    p_event! BBjPopupSelectEvent which contains event information
  - OnViewData
```
public void OnViewData(BBjPopupSelectEvent p_event!)
```
    Called when the view data popup menu item is selected on the widget control
    
    Parameters:
    p_event! BBjPopupSelectEvent which contains event information
  - OnWidgetControlMouseUp
```
public void OnWidgetControlMouseUp(BBjMouseUpEvent p_event!)
```
    An internal method used by the WidgetControl that is called when the user presses a mouse key down and then releases it over the widget window
    
    This routine responds to the mouse click and will either post custom events if the developer has registered for click events, or will execute default behavior based on which mouse button was pressed. By default, a left click adds a tooltip to the interior chart widget if the user clicked on a chart's data item, e.g. a bar in a bar chart or slice in a pie chart. By default, a right click displays the default popup Options menu which is also available by selecting a DashboardWidget's Options tool button.
    If the developer set callbacks for a DashboardWidgetClickEvent, DashboardWidgetLeftClickEvent, or DashboardWidgetRightClickEvent then the routine creates the relevant DashboardWidgetEvent(s) based on the registered events, then posts the custom event(s) so that the developer's callback routines execute in response to the mouse event.
    Parameters:
    p_event! BBjMouseUpEvent that contains event information
  - OnWidgetControlPopup
```
public void OnWidgetControlPopup(BBjPopupRequestEvent p_event!)
```
    An internal method used by the WidgetControl that is called when the mouse is right-clicked over the widget window
    
    This method exists so that a custom popup menu will be displayed instead of the default browser's popup menu.
    Parameters:
    p_event! BBjPopupRequestEvent that contains event information
  - popoutWindowResizeTimerEvent
```
public void popoutWindowResizeTimerEvent(BBjTimerEvent p_event!)
```
    An internal method used by the WidgetControl to resize the window when the popout window's resize timer event fires
    
    Parameters:
    p_event! BBjTimerEvent that contains event information
  - refresh
```
public void refresh()
```
    Refreshes the widget control
  - refresh
```
public void refresh(BBjNumber p_refreshType)
```
    Internal refresh routine that refreshes the widget control and sets the type of refresh based on what event initiated the event
    
    This routine responds to the WidgetControl's refresh event and will either pass the refresh request on to the interior widget or, if the developer has set a callback for the refresh event, it creates a DashboardWidgetRefreshEvent object then posts the custom event so that the developer's callback routine executes in response to the DashboardWidgetRefreshEvent.
    Parameters:
    p_refreshType The refresh type based on a constant defined in the DashboardWidgetRefreshEvent class. This can be set to one of the available constants, such as DashboardWidgetRefreshEvent.getREFRESH_TYPE_WIDGET().
    Since:
    BBj 17.00
  - refreshView
```
public void refreshView()
```
    An internal method to refresh the widget control's links, filters, and inner widget
    
    This is the result of the developer's custom code calling the DashboardWidget.refresh() method
    Since:
    BBj 17.00
  - setActive
```
public void setActive(BBjNumber p_active)
```
    Sets the active status of the widget control by setting the associated DashboardWidget's active flag
    
    Parameters:
    p_activate Active status of the widget control, 0=inactive, 1=active
  - setAutoRefreshConfigurationMenuItemEnabled
```
public void setAutoRefreshConfigurationMenuItemEnabled(BBjNumber p_enable)
```
    Sets the enable status of the auto refresh configuration menu item in the options menu
    
    Parameters:
    p_enable Indicates if the auto refresh configuration menu item should be enabled, 0=disabled, 1=enabled
  - setAutoRefreshEnabled
```
public void setAutoRefreshEnabled(BBjNumber p_autoRefreshEnabled)
```
    Sets the auto refresh enabled or disabled
    
    Parameters:
    p_autoRefreshEnabled Enable status of auto refresh. 0=disabled, 1=enabled
  - setAutoRefreshMenuItemEnabled
```
public void setAutoRefreshMenuItemEnabled(BBjNumber p_enable)
```
    Sets the enable status of the auto refresh menu item in the options menu
    
    Parameters:
    p_enable Indicates if the auto refresh menu item should be enabled, 0=disabled, 1=enabled
  - setAutoRefreshRate
```
public void setAutoRefreshRate(BBjNumber p_rate)
```
    Sets the auto refresh rate
    
    Parameters:
    p_rate Rate for the auto refresh interval
  - setAutoRefreshUnit
```
public void setAutoRefreshUnit(BBjNumber p_unit)
```
    Sets the auto refresh unit
    
    Parameters:
    p_unit Unit for the auto refresh, valid values are AutoRefreshUnit.getSeconds(), AutoRefreshUnit.getMinutes(), AutoRefreshUnit.getHours()
  - setBackColor
```
public void setBackColor(BBjColor p_backColor!)
```
    Sets the background color of the widget control
    
    Parameters:
    p_backColor! BBjColor used to set the background color of the widget control
  - setClickCallback
```
public void setClickCallback(DashboardWidget p_dashboardWidget!)
```
    Sets a callback for a left click event that occurs on the passed dashboard widget
    
    Parameters:
    p_dashboardWidget! DashboardWidget to set the callback for
  - setCloseButtonEnabled
```
public void setCloseButtonEnabled(BBjNumber p_enable)
```
    Sets the enable status of the close button in the widget control
    
    Parameters:
    p_enable Indicates if the close button should be enabled, 0=disabled, 1=enabled
  - setDraggingEnabled
```
public void setDraggingEnabled(BBjNumber p_draggingEnabled)
```
    Sets the dragging enable status of the widget control
    
    Parameters:
    p_draggingEnabled Dragging enabled status, 0=disabled, 1=enabled
  - setEmailMenuItemEnabled
```
public void setEmailMenuItemEnabled(BBjNumber p_enable)
```
    Sets the enable status of the email menu item in the options menu
    
    Parameters:
    p_enable Indicates if the email menu item should be enabled, 0=disabled, 1=enabled
  - setExportDataMenuItemEnabled
```
public void setExportDataMenuItemEnabled(BBjNumber p_enable)
```
    Sets the enable status of the export data menu item in the options menu
    
    Parameters:
    p_enable Indicates if the export data menu item should be enabled, 0=disabled, 1=enabled
  - setLeftClickCallback
```
public void setLeftClickCallback(DashboardWidget p_dashboardWidget!)
```
    Sets a callback for a left click event that occurs on the passed dashboard widget
    
    Parameters:
    p_dashboardWidget! DashboardWidget to set the callback for
  - setLocation
```
public void setLocation(BBjNumber p_x, BBjNumber p_y)
```
    Sets the location of the widget control
    
    Parameters:
    p_x X location of the widget control
    p_y Y location of the widget control
  - setManualRefreshMenuItemEnabled
```
public void setManualRefreshMenuItemEnabled(BBjNumber p_enable)
```
    Sets the enable status of the manual refresh menu item in the options menu
    
    Parameters:
    p_enable Indicates if the manual refresh menu item should be enabled, 0=disabled, 1=enabled
  - setOptionsButtonEnabled
```
public void setOptionsButtonEnabled(BBjNumber p_enable)
```
    Sets the enable status of the options button in the widget control
    
    Parameters:
    p_enable Indicates if the options button should be enabled, 0=disabled, 1=enabled
  - setPopoutButtonEnabled
```
public void setPopoutButtonEnabled(BBjNumber p_enable)
```
    Sets the enable status of the popout button in the widget control
    
    Parameters:
    p_enable Indicates if the popout button should be enabled, 0=disabled, 1=enabled
  - setPreviewImage
```
public void setPreviewImage(BBjImage p_previewImage!)
```
    Sets the preview image for the widget control that will be displayed in the customize dialog
    
    Parameters:
    p_previewImage! BBjImage that will be used as the preview image for the widget control that will be displayed in the customize dialog
  - setRefreshCallback
```
public void setRefreshCallback(DashboardWidget p_dashboardWidget!)
```
    Sets a callback for a refresh event that occurs on the passed dashboard widget
    
    Parameters:
    p_dashboardWidget! DashboardWidget to set the callback for
  - setRefreshConfigurationMenuEnabled
```
public void setRefreshConfigurationMenuEnabled(BBjNumber p_enable)
```
    Sets the enable status of the refresh configuration menu in the options menu
    
    Parameters:
    p_enable Indicates if the refresh configuration menu should be enabled, 0=disabled, 1=enabled
  - setRefreshMenuItemEnabled
```
public void setRefreshMenuItemEnabled(BBjNumber p_enable)
```
    Sets the enable status of the refresh menu item in the options menu
    
    Parameters:
    p_enable Indicates if the refresh menu item should be enabled, 0=disabled, 1=enabled
  - setRightClickCallback
```
public void setRightClickCallback(DashboardWidget p_dashboardWidget!)
```
    Sets a callback for a right click event that occurs on the passed dashboard widget
    
    Parameters:
    p_dashboardWidget! DashboardWidget to set the callback for
  - setSaveMenuItemEnabled
```
public void setSaveMenuItemEnabled(BBjNumber p_enable)
```
    Sets the enable status of the save menu item in the options menu
    
    Parameters:
    p_enable Indicates if the save menu item should be enabled, 0=disabled, 1=enabled
  - setSelectCallback
```
public void setSelectCallback(DashboardWidget p_dashboardWidget!)
```
    Sets a callback for a select event that occurs on the passed dashboard widget
    
    Parameters:
    p_dashboardWidget! DashboardWidget to set the callback for
  - setSelected
```
public void setSelected(BBjNumber p_selected)
```
    Sets the widget's selected status. This modifies the widget's appearance by changing the titlebar color and setting a CSS selector on the control to distinguish it visually from the other, non-selected dashboard widgets.
    
    Parameters:
    p_selected Indicates whether the widget should be set to selected status or not. 0=NotSelected, 1=Selected.
  - setSelectEnabled
```
public void setSelectEnabled(BBjNumber p_selectEnabled)
```
    Sets the selectability of the widget control
    
    Parameters:
    p_selectEnabled Selectable status, 0=disabled, 1=enabled
  - setSize
```
public void setSize(BBjNumber p_width, BBjNumber p_height)
```
    Sets the size of the widget control
    
    Parameters:
    p_width Width of the widget control
    p_height Height of the widget control
  - setTitle
```
public void setTitle(BBjString p_title$)
```
    Sets the title for the widget control
    
    Parameters:
    p_title$ Title for the widget control
  - setViewDataMenuItemEnabled
```
public void setViewDataMenuItemEnabled(BBjNumber p_enable)
```
    Sets the enable status of the view data menu item in the options menu
    
    Parameters:
    p_enable Indicates if the view data menu item should be enabled, 0=disabled, 1=enabled
  - setVisible
```
public void setVisible(BBjNumber p_visible)
```
    Sets the widget control's visibility
    
    Parameters:
    p_visible Visibility of the widget control. 0=invisibile, 1=visible

Class WidgetControl

Field Summary

Constructor Summary

Method Summary

Field Detail

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=1

MoveParentWindow=0

SelectEnabled=1

WidgetWindowX

WidgetWindowY

Constructor Detail

WidgetControl

Method Detail

activate

addFilter

addLink

destroy

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