Package org.eclipse.pde.ui.templates

Class 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void createControl​(Composite parent, int span)
      Creates the string option control.
      java.lang.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 setReadOnly​(boolean readOnly)
      Update the text widget style to be read only Added to default style (does not override)
      void setText​(java.lang.String newText)
      A utility version of the setValue method that accepts String objects.
      void setValue​(java.lang.Object value)
      Implements the superclass method by passing the string value of the new value to the widget

      • 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,
                    java.lang.String name,
                    java.lang.String label)
        The constructor.
        Parameters:
        section - the parent section
        name - the unique option name
        label - the translatable label of the option

    • Method Detail

      • setReadOnly

        public void setReadOnly​(boolean readOnly)
        Update the text widget style to be read only Added to default style (does not override)
        Parameters:
        readOnly - true to make this option read only, false otherwise

      • getText

        public java.lang.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​(java.lang.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​(java.lang.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 - the new enabled state