Class RadioButtonTag
- java.lang.Object
-
- org.apache.commons.jelly.TagSupport
-
- net.sf.jguiraffe.gui.builder.components.tags.FormBaseTag
-
- net.sf.jguiraffe.gui.builder.components.tags.ComponentBaseTag
-
- net.sf.jguiraffe.gui.builder.components.tags.InputComponentTag
-
- net.sf.jguiraffe.gui.builder.components.tags.PushButtonTag
-
- net.sf.jguiraffe.gui.builder.components.tags.RadioButtonTag
-
- All Implemented Interfaces:
ConditionalTag
,IconSupport
,org.apache.commons.jelly.Tag
public class RadioButtonTag extends PushButtonTag
A specific input component tag for creating a radio button.
Radio buttons are simple input components that allow to enter a boolean value: They can either be selected or deselected. Typically radio buttons are grouped together in a radio group, and then only one button of the group can be selected. To achieve this behavior, the radio buttons must be added to a radio group (by either nesting the radio button tags inside a
RadioGroupTag
or by specifying thegroups
attribute. Per default it is assumed that a radio button belongs to a group, so thenoField
attribute is set to true. If it is desired that a field handler is created for the radio button,noField
must be set to false explicitly.Radio buttons can have a label text and be associated with an icon. The following attributes are supported by this tag handler class (in addition to the default attributes allowed for all input component tags):
Attribute Description Optional text
With this attribute the label's text can directly be set. yes textres
Defines the resource ID for the label's text. The real text is resolved using the current resource manager and the current locale. yes resgrp
Specifies the resource group of the label's text. If set, this resource group is used when resolving the label's text as defined by the textres
attribute. If undefined, the form builder's default resource group will be used.yes alignment
Defines the relative position of the label's icon to its text. This can be one of the literal names of the TextIconAlignment
class.yes mnemonic
Here a mnemonic for this label can be specified. If the user enters this key, the associated component will be focused (if supported by the platform). yes mnemonicres
This attribute defines the mnemonic as a resource, which makes sense for i18n applications. yes This tag supports an icon, which can be defined by an
IconTag
in the tag's body. If neither a text nor an icon are defined, an exception will be thrown.- Version:
- $Id: RadioButtonTag.java 205 2012-01-29 18:29:57Z oheger $
- Author:
- Oliver Heger
-
-
Constructor Summary
Constructors Constructor Description RadioButtonTag()
Creates a new instance ofRadioButtonTag
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected ComponentHandler<?>
createPushButton(ComponentManager manager, boolean create)
Creates the radio button.protected void
processBeforeBody()
Performs processing before the execution of the tag body.-
Methods inherited from class net.sf.jguiraffe.gui.builder.components.tags.PushButtonTag
createComponentHandler, getTextIconData, setAlignment, setIcon, setMnemonic, setMnemonicres, setResgrp, setText, setTextres, validateTag
-
Methods inherited from class net.sf.jguiraffe.gui.builder.components.tags.InputComponentTag
addToGroups, checkName, createFieldHandler, getComponent, getComponentHandler, getComponentType, getDisplayName, getFieldValidator, getFormValidator, getGroups, getPropertyName, getReadTransformer, getTypeName, getWriteTransformer, handleGroups, insertField, isNoField, process, setComponentType, setDisplayName, setDisplayNamegrp, setDisplayNameres, setFieldValidator, setFormValidator, setGroups, setNoField, setPropertyName, setReadTransformer, setTypeName, setWriteTransformer
-
Methods inherited from class net.sf.jguiraffe.gui.builder.components.tags.ComponentBaseTag
getBackColor, getBackgroundColor, getConstraints, getFont, getFontRef, getForeColor, getForegroundColor, getName, getToolTipData, insertComponent, setBackColor, setConstraints, setFont, setFontRef, setForeColor, setName, setTooltip, setTooltipres, setTooltipresgrp
-
Methods inherited from class net.sf.jguiraffe.gui.builder.components.tags.FormBaseTag
canProcess, canProcess, convertToClass, convertToNumberWithUnit, convertToNumberWithUnit, doTag, findContainer, getBuilderData, getBuilderData, getIfName, getResourceText, getResourceText, getUnlessName, setIfName, setUnlessName
-
Methods inherited from class org.apache.commons.jelly.TagSupport
findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, getBody, getBodyText, getBodyText, getContext, getParent, invokeBody, isEscapeText, isTrim, setBody, setContext, setEscapeText, setParent, setTrim, trimBody
-
-
-
-
Method Detail
-
processBeforeBody
protected void processBeforeBody() throws org.apache.commons.jelly.JellyTagException, FormBuilderException
Performs processing before the execution of the tag body. This implementation checks whether this radio button is in the body of aRadioGroupTag
. If this is the case, it is added to the group.- Overrides:
processBeforeBody
in classInputComponentTag
- Throws:
org.apache.commons.jelly.JellyTagException
- if the tag is used incorrectlyFormBuilderException
- if an error occurs
-
createPushButton
protected ComponentHandler<?> createPushButton(ComponentManager manager, boolean create) throws FormBuilderException
Creates the radio button.- Specified by:
createPushButton
in classPushButtonTag
- Parameters:
manager
- the component managercreate
- the create flag- Returns:
- the component handler for the checkbox
- Throws:
FormBuilderException
- if an error occurs
-
-