Package org.eclipse.ui.cheatsheets

Class AbstractItemExtensionElement

  • public abstract class AbstractItemExtensionElement
extends Object
    Base class for adding controls to cheat sheet items.

    Subclasses are used in conjunction with the org.eclipse.ui.cheatsheets.cheatSheetItemExtension extension point. Subclasses must be public and have a public 1-arg constructor that takes the name of the attribute type String. The extension point specifies the name of the subclass and the name of the XML attribute that it can handle. When the cheat sheet framework encounters an item (or subitem) element in the cheat sheet content file with an attribute with a matching name, an instance of the corresponding item extension subclass is created. It is up to this instance to remember the attribute value if required. Later, when creating the visual controls for the item are being created, the instance is given the opportunity to add extra controls.

    Since:
    3.0

    • Constructor Detail

      • AbstractItemExtensionElement

        public AbstractItemExtensionElement​(String attributeName)
        Creates a new item element extension for handling the XML attributes of the given name.
        Parameters:
        attributeName - the name of the attribute that this item extension handles
        Throws:
        IllegalArgumentException - if attributeName is null

    • Method Detail

      • getAttributeName

        public final String getAttributeName()
        Returns the name of the XML attribute that this item extension handles.
        Returns:
        the name of the attribute that this item extension handles

      • handleAttribute

        public abstract void handleAttribute​(String attributeValue)
        Called by the cheat sheet framework to parse and extract information from the string value of the XML attribute.
        Parameters:
        attributeValue - the attribute value specified in the cheat sheet content file

      • createControl

        public abstract void createControl​(Composite composite)
        Called by the cheat sheet framework when creating the visual representation of a step. This method should add a small button (suggested size 16x16 pixels) to the given composite to decorate the step.

        Important note: In some presentations of the cheatsheet, the color of the background is varied to emphasize the current step. Because of this, it is important to always use the background color of the composite (composite.getBackground()) as the background color for any additional controls; otherwise the new controls will not match their surrounding.

        Parameters:
        composite - the composite to add extra controls to

      • dispose

        public abstract void dispose()
        Called by the cheat sheet framework to dispose of this item element extension.

        This is the last method called on the AbstractItemExtensionElement. At this point the controls (if they were ever created) have been disposed as part of an SWT composite. There is no guarantee that createControl() has been called, so the controls may never have been created.

        Within this method an item element extension may release any resources, fonts, images, etc.  held by this part. It is also very important to deregister all listeners.

        Clients should not call this method (the cheat sheet framework calls this method at appropriate times).