Added documentation, badly globalized constructors set to deprecated.

git-svn-id: https://svn.libreccm.org/ccm/trunk@2389 8810af33-2d31-482b-a856-94f89814c4df
master
pb 2013-10-27 18:24:45 +00:00
parent 6145059e25
commit feb9912e4b
3 changed files with 37 additions and 15 deletions

View File

@ -27,14 +27,14 @@ import com.arsdigita.bebop.parameters.ArrayParameter;
import com.arsdigita.bebop.util.BebopConstants; import com.arsdigita.bebop.util.BebopConstants;
/** /**
* A class * A class representing a <em>group</em> of associated checkboxes.
* representing a <em>group</em> of associated checkboxes.
* *
* @author Karl Goldstein * @author Karl Goldstein
* @author Uday Mathur * @author Uday Mathur
* @author Rory Solomon * @author Rory Solomon
* @author Michael Pih * @author Michael Pih
* @version $Id: CheckboxGroup.java 738 2005-09-01 12:36:52Z sskracic $ */ * @version $Id: CheckboxGroup.java 738 2005-09-01 12:36:52Z sskracic $
*/
public class CheckboxGroup extends OptionGroup implements BebopConstants { public class CheckboxGroup extends OptionGroup implements BebopConstants {
public CheckboxGroup(String name) { public CheckboxGroup(String name) {

View File

@ -28,8 +28,11 @@ import com.arsdigita.bebop.util.BebopConstants;
import com.arsdigita.xml.Element; import com.arsdigita.xml.Element;
/** /**
* A class representing * A class representing an option of a widget.
* 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 Rory Solomon
* @author Michael Pih * @author Michael Pih
@ -43,25 +46,44 @@ public class Option extends BlockStylable {
private Component m_component; private Component m_component;
private boolean m_isSelectOption; 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) { public Option(String label) {
this(label, label); this(label, label);
} }
/** /**
* This creates an Option whose component is a label consisting of the * Constructor creates an Option whose label part consisting of a string.
* string that is passed in. * 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) { public Option(String value, String label) {
setLabel(label); setLabel(label);
setValue(value); 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); setValue(value);
} }
/**
*
* @return
*/
public String getName() { public String getName() {
return m_group.getName(); return m_group.getName();
} }

View File

@ -3,7 +3,7 @@
<head> <head>
<title>com.arsdigita.mail</title> <title>com.arsdigita.mail</title>
</head> </head>
<body bgcolor="white"> <body>
<p> <p>