Package org.csstudio.opibuilder.util

Class WidgetDescriptor

java.lang.Object

org.csstudio.opibuilder.util.WidgetDescriptor

public class WidgetDescriptor
extends Object

This class help to hold the related information for a widget which are acquired from the extension. The widget model and editpart will be loaded lazily, which also make the widget plugin loaded lazily.

Constructor Summary

Constructors

Constructor	Description
WidgetDescriptor(IConfigurationElement element, String typeID, String name, String description, String iconPath, String category, String pluginId, String onlineHelpHtml)

Method Summary

Modifier and Type	Method	Description
final String	getCategory()
String	getDescription()
final String	getIconPath()
final String	getName()
String	getOnlineHelpHtml()
final String	getPluginId()
final String	getTypeID()
final AbstractBaseEditPart	getWidgetEditpart()
final AbstractWidgetModel	getWidgetModel()

Methods inherited from class java.lang.Object

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

Constructor Details

WidgetDescriptor

public WidgetDescriptor(IConfigurationElement element,
 String typeID,
 String name,
 String description,
 String iconPath,
 String category,
 String pluginId,
 String onlineHelpHtml)

Parameters:

element - The configurationElement which hold the

typeID - The typeID of the widget.

name - The name of the widget

iconPath - The relative icon path of the widget relative to its plugin

category - The category of the widget

pluginId - The pluginID where the widget belongs to.

Method Details

getWidgetModel

public final AbstractWidgetModel getWidgetModel()

Returns:

the model of the widget.

getWidgetEditpart

public final AbstractBaseEditPart getWidgetEditpart()

Returns:

the editpart of the widget.

getTypeID

public final String getTypeID()

Returns:

the typeID

getName

public final String getName()

Returns:

the name

getIconPath

public final String getIconPath()

Returns:

the iconPath

getCategory

public final String getCategory()

Returns:

the category

getPluginId

public final String getPluginId()

Returns:

the pluginId

getDescription

public String getDescription()

getOnlineHelpHtml

public String getOnlineHelpHtml()