IControlLocator Interface

com.bea.ide.control
IControlLocator Interface

public interface IControlLocator

Locates Controls for the IDE, mostly via the jar's control xml file.

Method Summary

public String
getDescription()
Get the description of this control.
public String
getDisplayGroup()
Group for this control.
public String
getDisplayName()
Get the displayable name of the control.
public int
getDisplayPriority()
menu/palette priority.
public Icon
getIcon()
Get the 16x16 icon for this control.
public Icon
getIcon(String path)
Find an icon in the jarfile which contains the control.
public Icon
getIcon32()
Get the 32x32 icon for this control.
public String
getImplementationClassName()
Get the name of the implmentation for this control.
public String
getInterfaceClassName()
Get the name of the interface for this control
public String
getVersion()
Get the version of the control.
public Object
getWizard()
get control creation wizard for this control.
public boolean
isDisplayable()
Should this control be shown on a palette/menu?

Method Detail

getDescription() Method

public String getDescription()
Get the description of this control.

Returns

a description string.

getDisplayGroup() Method

public String getDisplayGroup()
Group for this control. This will be the empty string if not specified by the control.

Returns

the group to which this control belongs.

getDisplayName() Method

public String getDisplayName()
Get the displayable name of the control.

Returns

the name to display

getDisplayPriority() Method

public int getDisplayPriority()
menu/palette priority.

Returns

the requested menu priority for the control, lower numbers should be given higher priority.

getIcon() Method

public Icon getIcon()
Get the 16x16 icon for this control.

Returns

an Icon specified by the control, or a default icon if none is specified.

getIcon(String) Method

public Icon getIcon(String path)
Find an icon in the jarfile which contains the control.

Returns

an Icon at the given path in the control's jar, null if not found.

getIcon32() Method

public Icon getIcon32()
Get the 32x32 icon for this control.

Returns

the Icon specified by the icon-32 property of the control, or a default icon if none is specified.

getImplementationClassName() Method

public String getImplementationClassName()
Get the name of the implmentation for this control.

Returns

the class name of the implementation, or null if unknown.

getInterfaceClassName() Method

public String getInterfaceClassName()
Get the name of the interface for this control

Returns

the class name of the control interface.

getVersion() Method

public String getVersion()
Get the version of the control.

Returns

the version string

getWizard() Method

public Object getWizard()
get control creation wizard for this control.

Returns

an instance of a ControlWizardSimple or ControlWizard to create/insert this control.

isDisplayable() Method

public boolean isDisplayable()
Should this control be shown on a palette/menu?

Returns

true if this should be displayed, false if it exists for information only.