Package com.im.ijc.core.api.views

Class IJCWidgetFactoriesProvider.FactoryInfo

java.lang.Object

com.im.ijc.core.api.views.IJCWidgetFactoriesProvider.FactoryInfo

Enclosing class:

IJCWidgetFactoriesProvider

public static class IJCWidgetFactoriesProvider.FactoryInfo
extends java.lang.Object

Description of a registered widget factory.

Constructor Summary

Constructors

Constructor	Description
FactoryInfo(IJCWidgetFactory factory, java.lang.String iconBaseWithExt, java.lang.String displayName, java.lang.String categoryKey)	Constructor for keeping backwards compatibility.
FactoryInfo(IJCWidgetFactory factory, java.lang.String iconBaseWithExt, java.lang.String displayName, java.lang.String categoryKey, boolean visible)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCategoryKey()
java.lang.String	getDisplayName()
IJCWidgetFactory	getFactory()
java.lang.String	getIconBaseWithExtension()
java.awt.Image	getImage16()	Deprecated. Use ImageUtilities.loadImage(java.lang.String)(getIconBaseWithExtension()).

Methods inherited from class java.lang.Object

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

Constructor Detail

FactoryInfo

public FactoryInfo(IJCWidgetFactory factory,
                   java.lang.String iconBaseWithExt,
                   java.lang.String displayName,
                   java.lang.String categoryKey)

Constructor for keeping backwards compatibility. Creates IJCWidgetFactoriesProvider.FactoryInfo visible set to true.

Parameters:

factory - the actual factory

iconBaseWithExt - path to icon

displayName - factory name in UI

categoryKey - key identifying the category in widget palette

FactoryInfo

public FactoryInfo(IJCWidgetFactory factory,
                   java.lang.String iconBaseWithExt,
                   java.lang.String displayName,
                   java.lang.String categoryKey,
                   boolean visible)

Method Detail

getFactory

public IJCWidgetFactory getFactory()

getImage16

public java.awt.Image getImage16()

Deprecated.

Use ImageUtilities.loadImage(java.lang.String)(getIconBaseWithExtension()).

Returns:

the 16x16 version of factory icon

getDisplayName

public java.lang.String getDisplayName()

getIconBaseWithExtension

public java.lang.String getIconBaseWithExtension()

Returns:

The icon's resource name to be found by ImageUtilities. See AbstractNode.setIconBaseWithExtension(java.lang.String) for description of the icon base name meaning.

Since:

6.1

getCategoryKey

public java.lang.String getCategoryKey()

Returns:

The id of palette category to which the factory belongs. Can be null.

Since:

6.1