com.anrisoftware.prefdialog.annotations.RadioButton Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of prefdialog-api Show documentation

Preferences dialog public application interface.

The newest version!

/*
 * Copyright 2013-2016 Erwin Müller 
 *
 * This file is part of prefdialog-api.
 *
 * prefdialog-api is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * prefdialog-api is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with prefdialog-api. If not, see .
 */
package com.anrisoftware.prefdialog.annotations;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * Field for a radio button. Radio buttons are usually in a group so the user
 * can chose one option for the group. For this single radio button an action
 * can be assigned that is called when the user clicks on the button.
 * 
 *
 * 
Examples
 *
 * Simple example.
 *
 *  * @FieldComponent
 * @FieldButton
 * @RadioButton
 * public boolean buttonField;
 * 
 *
 * With getter and setter.
 *
 *  * private boolean important;
 * 
 * public void setImportant(boolean important) {
 *     this.important = important;
 * }
 * 
 * @FieldComponent
 * @FieldButton
 * @RadioButton
 * public boolean isImportant() {
 *     return important;
 * }
 * 
 *
 * With button group.
 *
 *  * @FieldComponent
 * @FieldButton(group = "fieldGroup")
 * @RadioButton
 * public boolean buttonField0;
 * 
 * @FieldComponent
 * @FieldButton(group = "fieldGroup")
 * @RadioButton
 * public boolean buttonField1;
 * 
 * public javax.swing.ButtonGroup fieldGroup;
 * 
 *
 * @author Erwin Mueller, [email protected]
 * @since 1.0
 */
@Target({ FIELD, METHOD })
@Retention(RUNTIME)
@FieldAnnotation
@Documented
public @interface RadioButton {
}