diff --git a/ccm-core/src/com/arsdigita/bebop/form/CheckboxGroup.java b/ccm-core/src/com/arsdigita/bebop/form/CheckboxGroup.java index 4ec8803f6..bbadbe4b1 100755 --- a/ccm-core/src/com/arsdigita/bebop/form/CheckboxGroup.java +++ b/ccm-core/src/com/arsdigita/bebop/form/CheckboxGroup.java @@ -27,14 +27,14 @@ import com.arsdigita.bebop.parameters.ArrayParameter; import com.arsdigita.bebop.util.BebopConstants; /** - * A class - * representing a group of associated checkboxes. + * A class representing a group of associated checkboxes. * - * @author Karl Goldstein - * @author Uday Mathur - * @author Rory Solomon - * @author Michael Pih - * @version $Id: CheckboxGroup.java 738 2005-09-01 12:36:52Z sskracic $ */ + * @author Karl Goldstein + * @author Uday Mathur + * @author Rory Solomon + * @author Michael Pih + * @version $Id: CheckboxGroup.java 738 2005-09-01 12:36:52Z sskracic $ + */ public class CheckboxGroup extends OptionGroup implements BebopConstants { public CheckboxGroup(String name) { diff --git a/ccm-core/src/com/arsdigita/bebop/form/Option.java b/ccm-core/src/com/arsdigita/bebop/form/Option.java index fd3b0a9a2..e151ad3cf 100755 --- a/ccm-core/src/com/arsdigita/bebop/form/Option.java +++ b/ccm-core/src/com/arsdigita/bebop/form/Option.java @@ -28,8 +28,11 @@ import com.arsdigita.bebop.util.BebopConstants; import com.arsdigita.xml.Element; /** - * A class representing - * an option of a widget. + * A class representing an option of a widget. + * + * The Option consist of two parts: + * - a value + * - a label (display component used as label (title) of the option.) * * @author Rory Solomon * @author Michael Pih @@ -43,25 +46,44 @@ public class Option extends BlockStylable { private Component m_component; private boolean m_isSelectOption; + /** + * (Too) simple Constructor which uses a String as value as well as display + * component. + * @param label A String used as value as well as display component. + * @deprecated use Option(value,component) instead + */ public Option(String label) { this(label, label); } - /** - * This creates an Option whose component is a label consisting of the - * string that is passed in. + * Constructor creates an Option whose label part consisting of a string. + * This results in a badly globalized label part. The localization depends + * on the language selected at the time the Option is created. + * @deprecated use Option(value,component) instead */ public Option(String value, String label) { setLabel(label); setValue(value); } - public Option(String value, Component component) { - setComponent(component); + /** + * Constructor creates an Option whose label part consisting of a Component, + * usually a Label(GlobalizedMessage). + * This constructor should be used to create a fully globalized and + * localized user interface. + * @param value + * @param label + */ + public Option(String value, Component label) { + setComponent(label); setValue(value); } + /** + * + * @return + */ public String getName() { return m_group.getName(); } diff --git a/ccm-core/src/com/arsdigita/mail/package.html b/ccm-core/src/com/arsdigita/mail/package.html index 85779fc5f..5c49a0e88 100755 --- a/ccm-core/src/com/arsdigita/mail/package.html +++ b/ccm-core/src/com/arsdigita/mail/package.html @@ -3,7 +3,7 @@