public class DashboardWidgetLink
DashboardWidgetLink Data class for a link of a dashboard widget
The dashboard utility uses this method internally when you execute the DashboardWidget::addLink() method to create a DashboardWidgetLink and add it to an existing DashboardWidget
| Modifier and Type | Field and Description |
|---|---|
BBjNumber | BrowseOnSelectIndicates if the link should be browsed to when selected |
BBjNumber | DockLocationDock location of the link |
CustomObject | LinkSelectCallbackObject!CustomObject that contains the routine to handle a link select event |
BBjString | LinkSelectCallbackRoutine!Routine to handle a link select event |
BBjString | LinkSelectEventName!Name of the link select event |
static BBjNumber | ON_LINK_SELECT=1Constant for a link select event |
BBjString | Text$Text of link |
BBjString | ToolTip$Tool tip to be displayed when the mouse is hovered over the link |
BBjString | URL$Target URL of link |
| Constructor and Description |
|---|
DashboardWidgetLink(BBjString p_url$, BBjString p_text$, BBjString p_toolTip$, BBjNumber p_dockLocation, BBjNumber p_browseOnSelect)Constructs a DashboardWidgetLink The dashboard utility uses this method internally when you execute the DashboardWidget::addLink() method to create a DashboardWidgetLink and add it to an existing DashboardWidget |
| Modifier and Type | Method and Description |
|---|---|
DashboardWidgetLink | clone()Creates and returns a clone of the DashboardWidgetLink |
void | destroy()Destroys the link |
void | setCallback(BBjNumber p_event, BBjString p_callbackRoutine!)Sets a callback for a dashboard widget link event After you create a DashboardWidgetLink object by adding it to the desired DashboardWidget, call this method to have your custom code execute in response to the user selecting the link. The WidgetControl automatically responds to the user's link selection, creates the relevant DashboardWidgetLinkSelectEvent object, then posts the custom event so that the callback routine you specify in this method executes in response to the event. |
void | setCallback(BBjNumber p_event, CustomObject p_callbackObject!, BBjString p_callbackRoutine!)Sets a callback for a dashboard widget link event After you create a DashboardWidgetLink object by adding it to the desired DashboardWidget, call this method to have your custom code execute in response to the user selecting the link. The WidgetControl automatically responds to the user's link selection, creates the relevant DashboardWidgetLinkSelectEvent object, then posts the custom event so that the callback routine you specify in this method executes in response to the event. |
public BBjNumber BrowseOnSelectIndicates if the link should be browsed to when selected
public BBjNumber DockLocationDock location of the link
public CustomObject LinkSelectCallbackObject!
CustomObject that contains the routine to handle a link select event
public BBjString LinkSelectCallbackRoutine!Routine to handle a link select event
public BBjString LinkSelectEventName!Name of the link select event
public static BBjNumber ON_LINK_SELECT=1Constant for a link select event
public BBjString Text$Text of link
public BBjString ToolTip$Tool tip to be displayed when the mouse is hovered over the link
public BBjString URL$Target URL of link
public DashboardWidgetLink(BBjString p_url$, BBjString p_text$, BBjString p_toolTip$, BBjNumber p_dockLocation, BBjNumber p_browseOnSelect)
Constructs a DashboardWidgetLink
The dashboard utility uses this method internally when you execute the DashboardWidget::addLink() method to create a DashboardWidgetLink and add it to an existing DashboardWidget
p_url$ URL of the linkp_text$ Text of the linkp_toolTip$ Tool tip for the linkp_dockLocation Dock location of the link. Values can be DashboardWidget.getDOCK_LEFT() or DashboardWidget.getDOCK_RIGHT()p_browseOnSelect Indicates if the URL should be browsed to when selected. 0=Do not browse, 1=Browsepublic DashboardWidgetLink clone()Creates and returns a clone of the DashboardWidgetLink
public void destroy()
Destroys the link
public void setCallback(BBjNumber p_event, BBjString p_callbackRoutine!)
Sets a callback for a dashboard widget link event
After you create a DashboardWidgetLink object by adding it to the desired DashboardWidget, call this method to have your custom code execute in response to the user selecting the link. The WidgetControl automatically responds to the user's link selection, creates the relevant DashboardWidgetLinkSelectEvent object, then posts the custom event so that the callback routine you specify in this method executes in response to the event.
p_event Indicates the event registering for. Value is always DashboardWidgetLink.getON_LINK_SELECT().p_callbackRoutine! Routine to call when the event is triggeredpublic void setCallback(BBjNumber p_event, CustomObject p_callbackObject!, BBjString p_callbackRoutine!)
Sets a callback for a dashboard widget link event
After you create a DashboardWidgetLink object by adding it to the desired DashboardWidget, call this method to have your custom code execute in response to the user selecting the link. The WidgetControl automatically responds to the user's link selection, creates the relevant DashboardWidgetLinkSelectEvent object, then posts the custom event so that the callback routine you specify in this method executes in response to the event.
p_event Indicates the event registering for. Value is always DashboardWidgetLink.getON_LINK_SELECT().p_callbackObject! CustomObject that contains the routine to call when the event is triggeredp_callbackRoutine! Routine to call when the event is triggered