SUICheckBox
class SUICheckBox
A checkbox that can be used to disable or enable an option.
See the SUICheckBox component topic to learn more about SUICheckBox.
public class SUICheckBox extends Component
— Constructors (1) —
| Constructor | Description |
|---|---|
| SUICheckBox() | Creates a new SUICheckBox. |
— Methods (34) —
| Name | Description |
|---|---|
| boolean isChecked() | Returns true if SUICheckBox is checked, false if not. |
| void setPressed(boolean value) | Defines whether the SUICheckBox is being pressed or not to be "value" argument. |
| Color getUncheckedColor() | Returns the current color of the "OnUnchecked" state(when the SUICheckBox is unchecked) of the SUICheckBox. |
| void setUncheckedColor(Color color) | Sets the current color of the "OnUnchecked" state(when the SUICheckBox is unchecked) of the SUICheckBox to be "color" argument. |
| [Texture] getUncheckedImage() | Returns the current texture from the "OnUnchecked" state(when the SUICheckBox is unchecked) of the SUICheckBox. |
| void setUncheckedImage([Texture] texture) | Sets the current "OnUnchecked" state texture(when the SUICheckBox is unchecked) of the SUICheckBox to be "texture" argument. |
| boolean isUncheckedIgnoreMask() | Returns true if the "Ignore mask" option of the "OnUnchecked" state(when the SUICheckBox is unchecked) of the SUICheckBox is checked, false if not. |
| void setUncheckedIgnoreMask(boolean value) | Defines whether the "Ignore mask" option of the "OnUnchecked" state (when the SUICheckBox is unchecked) of the SUICheckBox is checked or unchecked to be "value" argument. |
| int getUncheckedBorder() | Returns the current border size of the "OnUnchecked" state(when the SUICheckBox is unchecked) of the SUICheckBox. |
| void setUncheckedBorder(int value) | Sets the current border size of the "OnUnchecked" state(when the SUICheckBox is unchecked) of the SUICheckBox to be "value" argument. |
| SUnitType getUncheckedBorderUnitType() | Returns the current border type("Pixel" or "DIP") of the "OnUnchecked" state(when the SUICheckBox is unchecked) of the SUICheckBox. |
| void setUncheckedBorderUnitType(SUnitType value) | Sets the current border type("Pixel" or "DIP") of the "OnUnchecked" state(when the SUICheckBox is unchecked) of the SUICheckBox to be "value" argument. |
| void setUncheckedBorder(int value, SUnitType unitType) | Sets current border size to be "value" argument and current border type("Pixel" or "DIP") of "OnUnchecked" state(when SUICheckBox is unchecked) of SUICheckBox to be "unitType" argument. |
| SImageType getUncheckedImageType() | Returns the current image type("Simple" or "Sliced") of the "OnUnchecked" state(when the SUICheckBox is unchecked) of the SUICheckBox. |
| void setUncheckedImageType(SImageType value) | Sets the current image type("Simple" or "Sliced") of the "OnUnchecked" state (when the SUICheckBox is unchecked) of the SUICheckBox to be "sImageType" argument. |
| Color getCheckedColor() | Returns the current color of the "OnChecked" state(when the SUICheckBox is checked) of the SUICheckBox. |
| void setCheckedColor(Color color) | Sets the current color of the "OnChecked" state(when the SUICheckBox is checked) of the SUICheckBox to be "color" argument. |
| [Texture] getCheckedImage() | Returns the current texture from the "OnChecked" state(when the SUICheckBox is checked) of the SUICheckBox. |
| void setCheckedImage([Texture] texture) | Sets the current "OnChecked" state texture(when the SUICheckBox is checked) of the SUICheckBox to be "texture" argument. |
| boolean isCheckedIgnoreMask() | Returns true if the "Ignore mask" option of the "OnChecked" state(when the SUICheckBox is checked) of the SUICheckBox is checked, false if not. |
| void setCheckedIgnoreMask(boolean value) | Defines whether the "Ignore mask" option of the "OnChecked" state(when the SUICheckBox is checked) of the SUICheckBox is checked or unchecked to be "value" argument. |
| int getCheckedBorder() | Returns the current border size of the "OnChecked" state(when the SUICheckBox is checked) of the SUICheckBox. |
| void setCheckedBorder(int value) | Sets the current border size of the "OnChecked" state(when the SUICheckBox is checked) of the SUICheckBox to be "value" argument. |
| SUnitType getCheckedBorderUnitType() | Returns the current border type("Pixel" or "DIP") of the "OnChecked" state(when the SUICheckBox is checked) of the SUICheckBox. |
| void setCheckedBorderUnitType(SUnitType value) | Sets the current border type("Pixel" or "DIP") of the "OnChecked" state(when the SUICheckBox is checked) of the SUICheckBox to be "value" argument. |
| void setCheckedBorder(int value, SUnitType unitType) | Sets current border size to be "value" argument and current border type("Pixel" or "DIP") of "OnChecked" state(when SUICheckBox is checked) of SUICheckBox to be "unitType" argument. |
| SImageType getCheckedImageType() | Returns the current image type("Simple" or "Sliced") of the "OnChecked" state(when the SUICheckBox is checked) of the SUICheckBox. |
| void setCheckedImageType(SImageType value) | Sets the current image type("Simple" or "Sliced") of the "OnChecked" state (when the SUICheckBox is checked) of the SUICheckBox to be "sImageType" argument. |
| boolean isClickable() | Returns true if the SUICheckBox has the "Clickable" option to be "Event" options checked, false if not. |
| void setClickable(boolean value) | Defines if the SUICheckBox will have the "Clickable" option to be "Event" options checked or unchecked to be "value" argument. |
| STargetRect getTargetRectType() | Returns the current Target("MySelf", "Parent" or "Other") type option to be "Event" options of the SUICheckBox. |
| void setTargetRectType(STargetRect value) | Sets the current Target("MySelf", "Parent" or "Other") type option to be "Event" options of the SUICheckBox to be "value" argument. |
| SpatialObject getTargetRectObject() | SUICheckBoxReturns the current type of Target("MySelf", "Parent" or "Other") along with SUICheckBox SpatialObject. |
| void setTargetRectObject(SpatialObject object) | SUICheckBoxSets the current Target("MySelf", "Parent" or "Other") type of the SpatialObject passed to be "object" argument. |