Eclipse PDE
Release 3.1

org.eclipse.pde.ui.templates
Class StringOption

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

public class StringOption
extends TemplateOption

This template option can be used to collect string option from the user in the template section wizard page.

Since:
2.0

Constructor Summary
StringOption(BaseOptionTemplateSection section, String name, String label)
          The constructor.
 
Method Summary
 void createControl(Composite parent, int span)
          Creates the string option control.
 String getText()
          A utility version of the getValue() method that converts the current value into the String object.
 boolean isEmpty()
          A string option is empty if its text field contains no text.
 void setEnabled(boolean enabled)
          Implements the superclass method by passing the enabled state to the option's widget.
 void setText(String newText)
          A utility version of the setValue method that accepts String objects.
 void setValue(Object value)
          Implements the superclass method by passing the string value of the new value to the widget
 
Methods inherited from class org.eclipse.pde.ui.templates.TemplateOption
getMessageLabel, getName, getValue, 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

StringOption

public StringOption(BaseOptionTemplateSection section,
                    String name,
                    String label)
The constructor.

Parameters:
section - the parent section
name - the unique option name
label - the translatable label of the option
Method Detail

getText

public String getText()
A utility version of the getValue() method that converts the current value into the String object.

Returns:
the string version of the current value.

setText

public void setText(String newText)
A utility version of the setValue method that accepts String objects.

Parameters:
newText - the new text value of the option
See Also:
setValue(Object)

setValue

public void setValue(Object value)
Implements the superclass method by passing the string value of the new value to the widget

Overrides:
setValue in class TemplateOption
Parameters:
value - the new option value

createControl

public void createControl(Composite parent,
                          int span)
Creates the string option control.

Specified by:
createControl in class TemplateField
Parameters:
parent - parent composite of the string option widget
span - the number of columns that the widget should span

isEmpty

public boolean isEmpty()
A string option is empty if its text field contains no text.

Overrides:
isEmpty in class TemplateOption
Returns:
true if there is no text in the text field.

setEnabled

public void setEnabled(boolean enabled)
Implements the superclass method by passing the enabled state to the option's widget.

Overrides:
setEnabled in class TemplateOption
Parameters:
enabled -

Eclipse PDE
Release 3.1

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