ICustomizer Interface

ICustomizer Interface

This Package | All Packages

public interface ICustomizer

The ICustomizer interface represents the implementation of a customizer for a particular component. A customizer implements the ability to create a set of property pages for a component, to get a list of design-time verbs for the component, and to execute those verbs. Instances of objects that implement the ICustomizer interface are created by the getCustomizer() method of the IClassInfo interface.

Methods
Name Description
edit() Edits the component associated with the customizer.
getDesignFilter() Allows your component to support a design time user interface.
getDesignPages() Returns an array of of classes for each design page that this component utilizes.
getVerbs() Returns the design-time verbs supported by the component associated with the customizer.
performVerb(CustomizerVerb verb) Performs the action associated with the given verb on the component associated with the customizer.

Methods

ICustomizer.edit

Syntax
public void edit();
Description

Edits the component associated with the customizer. This method should perform the default editing action for the component. The method is typically invoked when the user double-clicks the component in the design- time environment.

ICustomizer.getDesignFilter

Syntax
public IDesignFilter getDesignFilter();
Return Value

Returns an IDesignFilter object if your component requires design time message filtering; otherwise, returns null.

Description

Allows your component to support a design time user interface. A TabStrip control, for example, has a design time user interface that allows the user to click the tabs to change tabs. To implement this, TabStrip has a design filter that allows mouse and keyboard messages to be sent to the tabs.

ICustomizer.getDesignPages

Syntax
public Class[] getDesignPages();
Description

Returns an array of of classes for each design page that this component utilizes. Each returning class must implement IDesignPage.

ICustomizer.getVerbs

Syntax
public CustomizerVerb[] getVerbs();
Description

Returns the design-time verbs supported by the component associated with the customizer. The verbs returned by this method are typically displayed in a right-click menu by the design-time environment. The return value may be null if the component has no design-time verbs. When a user selects one of the verbs, the performVerb() method is invoked with the the corresponding CustomizerVerb object. Note: A design-time environment typically provides a "Properties..." entry on a component's right-click menu. Therefore, the getVerbs() method should not include such an entry in the returned list of verbs.

ICustomizer.performVerb

Syntax
public void performVerb( CustomizerVerb verb );
Description

Performs the action associated with the given verb on the component associated with the customizer. The verb parameter is one of the verbs previously returned by a call to the getVerbs() method.