Dashboard

Class ImageWidget

java.lang.Object

Dashboard.BaseWidget

Dashboard.BBjWidget

Dashboard.ImageWidget

All Implemented Interfaces:

RefreshableWidget, SaveableWidget, Widget

public class ImageWidget
extends BBjWidget
implements SaveableWidget

A Dashboard Utility Widget that displays an image retrieved from a file path or a URL

Field Summary

Fields inherited from class Dashboard.BBjWidget

BASIS_UTILITY_DEVICE_PIXEL_RATIO_KEY_NAME$, DevicePixelRatio!

Fields inherited from class Dashboard.BaseWidget

BASIS_DASHBOARD_UTILITY_FILL_ERROR_ACTION_KEY_NAME$, CachedImage!, DashboardWidget!, FillErrorAction, ON_FILL_ERROR_IGNORE, ON_FILL_ERROR_STOP, ON_FILL_ERROR_WARN, UserData!

Constructor Summary

Constructors

Constructor and Description
ImageWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$) Creates an ImageWidget without an image, which defaults to a transparent image
ImageWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_imageName$) Creates an ImageWidget specifying an image file for the image source
ImageWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, URL p_imageURL!) Creates an ImageWidget specifying a Java URL for the image source.

Method Summary

Modifier and Type	Method and Description
ImageWidget	clone() An internal method used by the Dashboard class to clone a category widget so that it may be displayed in a popped out window
void	create(BBjChildWindow p_widgetControlWindow!) Creates the ImageWidget
void	destroy() Destroys the ImageWidget
BBjString	getImageName() Returns the image name for the widget.
URL	getImageURL() Returns the image URL for the widget.
BBjNumber	isDestroyed() Returns if the ImageWidget is destroyed
void	refresh() Refreshes the image, which results in the widget showing an up-to-date version of the images if it has changed on disk or from the URL
void	resize(BBjNumber p_width, BBjNumber p_height) Resizes the widget using the provided with and height
void	save() Saves the image
void	setImage(BBjString p_imageName$) Sets the image for the widget.

Methods inherited from class Dashboard.BBjWidget

display, getDevicePixelRatio, logQueryPerformance, setDevicePixelRatio

Methods inherited from class Dashboard.BaseWidget

active, getClientSlash, getFillError, getFillErrorDesc, getImage, getImage, imageFileSaveDialog, logError, name, previewImage, previewText, setActive, setFillErrorDisplayImage, setFillErrorDisplayText, setLastSaveDir, spacesValid, title

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageWidget

public ImageWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$)

Creates an ImageWidget without an image, which defaults to a transparent image

Parameters:

p_name$ - The widget's name

p_title$ - The widget's title

p_previewText$ - The widget's preview text as shown in the Customize view and the widget toolbar's tooltip

p_previewImage$ - The widget's preview image. If this is an empty string, then one will be created automatically in the Customize view.

ImageWidget

public ImageWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
BBjString p_imageName$)

Creates an ImageWidget specifying an image file for the image source

Parameters:

p_name$ - The widget's name

p_title$ - The widget's title

p_previewText$ - The widget's preview text as shown in the Customize view and the widget toolbar's tooltip

p_previewImage$ - The widget's preview image. If this is an empty string, then one will be created automatically in the Customize view.

p_imageName$ - The widget's image, as a string that contains a path to the image file used as the source

ImageWidget

public ImageWidget(BBjString p_name$,
BBjString p_title$,
BBjString p_previewText$,
BBjString p_previewImage$,
URL p_imageURL!)

Creates an ImageWidget specifying a Java URL for the image source. Note that depending on the speed of the internet connection the host, retrieving an image from a URL may be slow.

Parameters:

p_name$ - The widget's name

p_title$ - The widget's title

p_previewText$ - The widget's preview text as shown in the Customize view and the widget toolbar's tooltip

p_previewImage$ - The widget's preview image. If this is an empty string, then one will be created automatically in the Customize view.

p_imageURL! - A Java URL containing the path to the image used as the source

See Also:

URL documentation for more information.

Method Detail

create

public void create(BBjChildWindow p_widgetControlWindow!)

Creates the ImageWidget

Specified by:

create in interface Widget

Overrides:

create in class BBjWidget

Parameters:

p_widgetControlWindow! - The BBjChildWindow that will contain the widget

setImage

public void setImage(BBjString p_imageName$)

Sets the image for the widget. This method is typically used when you want to set the widget's image in response to a refresh or filter event.

Parameters:

p_imageName$ - A string containing the path to the image file

resize

public void resize(BBjNumber p_width,
BBjNumber p_height)

Resizes the widget using the provided with and height

Specified by:

resize in interface Widget

Overrides:

resize in class BBjWidget

Parameters:

p_width - The width of the widget in pixels.

p_height - The height of the widget in pixels.

refresh

public void refresh()

Refreshes the image, which results in the widget showing an up-to-date version of the images if it has changed on disk or from the URL

Specified by:

refresh in interface RefreshableWidget

save

public void save()

Saves the image

Specified by:

save in interface SaveableWidget

getImageName

public BBjString getImageName()

Returns the image name for the widget.

Returns:

A string containing the path to the image file

getImageURL

public URL getImageURL()

Returns the image URL for the widget.

Returns:

A URL containing the location of the image file

destroy

public void destroy()

Destroys the ImageWidget

Specified by:

destroy in interface Widget

Overrides:

destroy in class BBjWidget

isDestroyed

public BBjNumber isDestroyed()

Returns if the ImageWidget is destroyed

Specified by:

isDestroyed in interface Widget

Overrides:

isDestroyed in class BBjWidget

Returns:

Returns 1 if destroyed, otherwise 0 is returned

clone

public ImageWidget clone()

An internal method used by the Dashboard class to clone a category widget so that it may be displayed in a popped out window

Specified by:

clone in interface Widget

Overrides:

clone in class Object

Returns:

A cloned version of the original widget