Dashboard

Class DashboardWidgetLink

java.lang.Object

Dashboard.DashboardWidgetLink

public class DashboardWidgetLink
extends Object

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

Field Summary

Fields

Modifier and Type	Field and Description
BBjNumber	BrowseOnSelect Indicates if the link should be browsed to when selected
BBjNumber	DockLocation Dock 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 Constant 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 Summary

Constructors

Constructor and Description
DashboardWidgetLink(BBjString p_url$, BBjString p_text$, BBjString p_toolTip$, BBjNumber p_dockLocation, BBjNumber p_browseOnSelect) Constructs a DashboardWidgetLink

Method Summary

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
void	setCallback(BBjNumber p_event, CustomObject p_callbackObject!, BBjString p_callbackRoutine!) Sets a callback for a dashboard widget link event

Methods inherited from class java.lang.Object

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

Field Detail

URL$

public BBjString URL$

Target URL of link

Text$

public BBjString Text$

Text of link

ToolTip$

public BBjString ToolTip$

Tool tip to be displayed when the mouse is hovered over the link

DockLocation

public BBjNumber DockLocation

Dock location of the link

BrowseOnSelect

public BBjNumber BrowseOnSelect

Indicates if the link should be browsed to when selected

LinkSelectEventName!

public BBjString LinkSelectEventName!

Name of the link select event

LinkSelectCallbackObject!

public CustomObject LinkSelectCallbackObject!

CustomObject that contains the routine to handle a link select event

LinkSelectCallbackRoutine!

public BBjString LinkSelectCallbackRoutine!

Routine to handle a link select event

ON_LINK_SELECT

public static BBjNumber ON_LINK_SELECT

Constant for a link select event

Constructor Detail

DashboardWidgetLink

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

Parameters:

p_url$ - URL of the link

p_text$ - Text of the link

p_toolTip$ - Tool tip for the link

p_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 = Browse

Method Detail

clone

public DashboardWidgetLink clone()

Creates and returns a clone of the DashboardWidgetLink

Overrides:

clone in class Object

Returns:

Returns the cloned DashboardWidgetLink

setCallback

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.

Parameters:

p_event - Indicates the event registering for. Value is always DashboardWidgetLink.getON_LINK_SELECT().

p_callbackRoutine! - Routine to call when the event is triggered

setCallback

public 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.

Parameters:

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 triggered

p_callbackRoutine! - Routine to call when the event is triggered

destroy

public void destroy()

Destroys the link