Package de.julianweinelt.datacat.dbx.api.ui.components

Class ComponentCheckbox

java.lang.Object

de.julianweinelt.datacat.dbx.api.ui.Component<Boolean,ComponentCheckbox>

de.julianweinelt.datacat.dbx.api.ui.components.ComponentCheckbox

public class ComponentCheckbox
extends Component<Boolean,ComponentCheckbox>

Constructor Summary

Constructors

Constructor	Description
ComponentCheckbox()

Method Summary

Modifier and Type	Method	Description
ComponentCheckbox	action(Consumer<ComponentCheckbox> action)
ComponentCheckbox	checkLabel(String checkLabel)
JComponent	create()	Should return the internal Swing object.
boolean	expandHorizontally()	Defines if the component should be expanded to the window's width size in the component's parent screen.
ComponentCheckbox	initialValue(Object val)	For setting an initial value that should be displayed before any of the user's input. It should always return the instance of the Component.
Boolean	value()	Should return the value of the Component's Swing Object. e.g., if implementing a text field, it should return the entered value of the text field.

Methods inherited from class de.julianweinelt.datacat.dbx.api.ui.Component

createLabel, hasLabel, label

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ComponentCheckbox

public ComponentCheckbox()

Method Details

checkLabel

public ComponentCheckbox checkLabel(String checkLabel)

expandHorizontally

public boolean expandHorizontally()

Description copied from class: Component

Defines if the component should be expanded to the window's width size in the component's parent screen.

Example: a horizontal line for splitting content

Specified by:

expandHorizontally in class Component<Boolean,ComponentCheckbox>

Returns:

true if it should be expanded, otherwise false

initialValue

public ComponentCheckbox initialValue(Object val)

Description copied from class: Component

For setting an initial value that should be displayed before any of the user's input.
It should always return the instance of the Component.

Implementation example:

 protected JTextField textField;

 @Override
 public ComponentTextField initialValue(Object value) {
     if (value instanceof String) {
         textField.setText((String) value);
     }
     return this;
 }
 

Specified by:

initialValue in class Component<Boolean,ComponentCheckbox>

Parameters:

val - The value to set.

Returns:

The Component's instance.

value

public Boolean value()

Description copied from class: Component

Should return the value of the Component's Swing Object. e.g., if implementing a text field, it should return the entered value of the text field.

Specified by:

value in class Component<Boolean,ComponentCheckbox>

Returns:

The entered value of this component.

action

public ComponentCheckbox action(Consumer<ComponentCheckbox> action)

create

public JComponent create()

Description copied from class: Component

Should return the internal Swing object.

Specified by:

create in class Component<Boolean,ComponentCheckbox>

Returns:

An object extending JComponent