Package org.eclipse.pde.ui.templates
Class AbstractChoiceOption
java.lang.Object
org.eclipse.pde.ui.templates.TemplateField
org.eclipse.pde.ui.templates.TemplateOption
org.eclipse.pde.ui.templates.AbstractChoiceOption
- Direct Known Subclasses:
ComboChoiceOption,RadioChoiceOption
Abstract implementation of the TemplateOption that allows users to choose a value from
the fixed set of options.
- Since:
- 2.0
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionAbstractChoiceOption(BaseOptionTemplateSection section, String name, String label, String[][] choices) Constructor for AbstractChoiceOption. -
Method Summary
Modifier and TypeMethodDescriptionprotected CompositecreateComposite(Composite parent, int span) protected GridDataReturns the string value of the current choice.protected booleanprotected voidselectChoice(String choice) protected abstract voidselectOptionChoice(String choice) voidsetEnabled(boolean enabled) Sets the enabled state of this option.protected abstract voidsetOptionEnabled(boolean enabled) protected abstract voidsetOptionValue(Object value) voidImplements the superclass method by passing the new value to the option's widget.protected voidImplements the superclass method by passing the new value to the option's widget; updates to the combo can be supressed.Methods inherited from class org.eclipse.pde.ui.templates.TemplateOption
getMessageLabel, getName, getValue, isEmpty, isEnabled, isRequired, setName, setRequiredMethods inherited from class org.eclipse.pde.ui.templates.TemplateField
createControl, createLabel, getLabel, getSection, setLabel
-
Field Details
-
fChoices
-
-
Constructor Details
-
AbstractChoiceOption
public AbstractChoiceOption(BaseOptionTemplateSection section, String name, String label, String[][] choices) Constructor for AbstractChoiceOption.- Parameters:
section- the parent section.name- the unique namelabel- the presentable labelchoices- the list of choices from which the value can be chosen. Each array entry should be an array of size 2, where position 0 will be interpeted as the choice unique name, and position 1 as the choice presentable label.
-
-
Method Details
-
getChoice
Returns the string value of the current choice.- Returns:
- the current choice or null if not initialized.
-
setValue
Implements the superclass method by passing the new value to the option's widget.- Overrides:
setValuein classTemplateOption- Parameters:
value- the new value.
-
setValue
Implements the superclass method by passing the new value to the option's widget; updates to the combo can be supressed.- Parameters:
value- the new value.updateControl- true to have the Combo's displayed value updated too, false to indicate that this isn't necessary.- Since:
- 3.4
-
setOptionValue
-
setEnabled
public void setEnabled(boolean enabled) Description copied from class:TemplateOptionSets the enabled state of this option. The action presentation of the enabled state depends on the implementing option.- Overrides:
setEnabledin classTemplateOption- Parameters:
enabled- the new enabled state
-
setOptionEnabled
protected abstract void setOptionEnabled(boolean enabled) -
fill
-
createComposite
-
selectChoice
-
selectOptionChoice
-
isBlocked
protected boolean isBlocked()
-