public abstract class AbstractItemExtensionElement extends Object
Subclasses are used in conjunction with the
point. Subclasses must be public and have a public 1-arg constructor
that takes the name of the attribute type
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.
|Constructor and Description|
Creates a new item element extension for handling the XML attributes of the given name.
|Modifier and Type||Method and Description|
Called by the cheat sheet framework when creating the visual representation of a step.
Called by the cheat sheet framework to dispose of this item element extension.
Returns the name of the XML attribute that this item extension handles.
Called by the cheat sheet framework to parse and extract information from the string value of the XML attribute.
public AbstractItemExtensionElement(String attributeName)
attributeName- the name of the attribute that this item extension handles
public final String getAttributeName()
public abstract void handleAttribute(String attributeValue)
attributeValue- the attribute value specified in the cheat sheet content file
public abstract void createControl(Composite composite)
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
composite- the composite to add extra controls to
public abstract void dispose()
This is the last method called on the
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).
Copyright (c) 2000, 2017 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.