Package com.ptc.core.components.rendering.guicomponents

Class RadioButton

java.lang.Object
com.ptc.core.components.rendering.AbstractGuiComponent
com.ptc.core.components.rendering.guicomponents.HTMLGuiComponent
com.ptc.core.components.rendering.guicomponents.RadioButton
All Implemented Interfaces:
GuiComponent, com.ptc.netmarkets.util.misc.NmFormatable, Serializable
public class RadioButton extends HTMLGuiComponent
A simple GUI component that represents a HTML radio button.

Supported API: true

Extendable: false

Example :

RadioButton r1 = new RadioButton();
String description = "Inline description for Radio Button";
r1.setValue("r1val");
r1.setId("r1");
r1.setChecked(true);
r1.setDescription(description); //sets the description for the radio button.

See Also:

  • Method Details

    • isChecked

      public boolean isChecked()
      Determines whether or not the given radio button is checked.

      Supported API: true
      Returns:
      boolean

    • setChecked

      public void setChecked(boolean a_Checked)
      Set RadioButton as checked or unchecked.

      Supported API: true
      Parameters:
      a_Checked -

    • setValue

      public void setValue(String value)
      Set the value of radio button that represents HTML name.

      Supported API: true
      Parameters:
      value - The value.

    • getValue

      public String getValue()
      Get the radio button name.

      Supported API: true
      Returns:
      radio button name.

    • getDescription

      public String getDescription()
      Get the description of radio button.

      Supported API: true
      Returns:
      description

    • setDescription

      public void setDescription(String description)
      Set the description for radio button.

      Supported API: true
      Parameters:
      description -

    • getId

      public String getId()
      Gets the Id of radio button. A string used to identify the component. Generated as the HTML id attribute.

      Supported API: true
      Overrides:
      getId in class AbstractGuiComponent
      Returns:
      The radio button identifier.

    • setId

      public void setId(String eyeD)
      Sets the Id for the radio button. A string used to identify the component. Generated as the HTML id attribute.

      Supported API: true
      Overrides:
      setId in class AbstractGuiComponent
      Parameters:
      eyeD - The radio button identifier.

    • setRenderLabel

      public void setRenderLabel(boolean rl)
      Determines to render label. Default is false. when true the renderer for the radio button will render the label also.

      Supported API: true
      Overrides:
      setRenderLabel in class AbstractGuiComponent
      Parameters:
      rl -

    • setRenderLabelOnRight

      public void setRenderLabelOnRight(boolean rlor)
      Determines to render label on right of the radio button. Default is false. when true; renders the label to the right of the radio button.

      Supported API: true
      Overrides:
      setRenderLabelOnRight in class AbstractGuiComponent
      Parameters:
      rlor -

    • setRequired

      public void setRequired(boolean a_required)
      Sets the required property true or false for RadioButton. Default is false. If the given value is true, the radio button marked as required.

      Supported API: true
      Overrides:
      setRequired in class AbstractGuiComponent
      Parameters:
      a_required -