Eclipse PDE
Release 3.2

org.eclipse.pde.ui.templates
Class RadioChoiceOption

java.lang.Object
  extended byorg.eclipse.pde.ui.templates.TemplateField
      extended byorg.eclipse.pde.ui.templates.TemplateOption
          extended byorg.eclipse.pde.ui.templates.AbstractChoiceOption
              extended byorg.eclipse.pde.ui.templates.RadioChoiceOption

public class RadioChoiceOption
extends AbstractChoiceOption

Implementation of the AbstractTemplateOption that allows users to choose a value from the fixed set of options using radio buttons.

Since:
3.2

Field Summary
 
Fields inherited from class org.eclipse.pde.ui.templates.AbstractChoiceOption
fChoices
 
Constructor Summary
RadioChoiceOption(BaseOptionTemplateSection section, String name, String label, String[][] choices)
          Constructor for RadioChoiceOption.
 
Method Summary
 void createControl(Composite parent, int span)
          Subclasses must implement this method to create the control of the template field.
protected  void selectOptionChoice(String choice)
           
protected  void setOptionEnabled(boolean enabled)
           
protected  void setOptionValue(Object value)
           
 
Methods inherited from class org.eclipse.pde.ui.templates.AbstractChoiceOption
createComposite, fill, getChoice, isBlocked, selectChoice, setEnabled, setValue
 
Methods inherited from class org.eclipse.pde.ui.templates.TemplateOption
getMessageLabel, getName, getValue, isEmpty, isEnabled, isRequired, setName, setRequired
 
Methods inherited from class org.eclipse.pde.ui.templates.TemplateField
createLabel, getLabel, getSection, setLabel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RadioChoiceOption

public RadioChoiceOption(BaseOptionTemplateSection section,
                         String name,
                         String label,
                         String[][] choices)
Constructor for RadioChoiceOption. Number of choices must be 2, otherwise an assertion will fail.

Parameters:
section - the parent section.
name - the unique name
label - the presentable label
choices - the list of choices from which the value can be chosen. This list must be of size 2. 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 Detail

createControl

public void createControl(Composite parent,
                          int span)
Description copied from class: TemplateField
Subclasses must implement this method to create the control of the template field.

Specified by:
createControl in class TemplateField
Parameters:
parent - the parent composite the control should be created in
span - number of columns that the control should span

setOptionValue

protected void setOptionValue(Object value)
Specified by:
setOptionValue in class AbstractChoiceOption

setOptionEnabled

protected void setOptionEnabled(boolean enabled)
Specified by:
setOptionEnabled in class AbstractChoiceOption

selectOptionChoice

protected void selectOptionChoice(String choice)
Specified by:
selectOptionChoice in class AbstractChoiceOption

Eclipse PDE
Release 3.2

Copyright (c) IBM Corp. and others 2000, 2006. All Rights Reserved.