com.raj.htmlForms
Class HtmlCheckBoxGroup

java.lang.Object
  |
  +--com.raj.htmlForms.HtmlFormElement
        |
        +--com.raj.htmlForms.HtmlInput
              |
              +--com.raj.htmlForms.HtmlGroups
                    |
                    +--com.raj.htmlForms.HtmlCheckBoxGroup

public class HtmlCheckBoxGroup
extends HtmlGroups

This class generates a group of HTML checkboxes. Each checkbox will have the same name, but different values and text as generated by an appropriate data structure. This class implements all of the HTML 4.01 Transitional attributes of a checkbox as defined in the W3C spec.

This class (HtmlCheckBoxGroup.java) is part of the com.raj.htmlForms package that automatically generates HTML forms programmatically.

CREATED 22-FEB-2002, Copyright (c) Rajnish Bhaskar 2002

Author:
Rajnish Bhaskar
See Also:
W3C reference for the <input> tag

Field Summary
 
Fields inherited from class com.raj.htmlForms.HtmlFormElement
isXHTML, out
 
Constructor Summary
HtmlCheckBoxGroup(java.io.Writer w)
          Minimal constructor for any form element.
HtmlCheckBoxGroup(java.io.Writer w, boolean x, java.lang.String n)
          Constructor that sets the writer and name and a boolean which determines whether or not XHTML will be written
HtmlCheckBoxGroup(java.io.Writer w, java.lang.String n)
          Constructor that just sets the name of the element
HtmlCheckBoxGroup(java.io.Writer w, java.lang.String n, java.util.Map e)
          Constructor that sets the name of the element and the entries
HtmlCheckBoxGroup(java.io.Writer w, java.lang.String n, java.util.Map e, java.lang.String c)
          Constructor that sets the name of the element and the entries
 
Method Summary
 java.lang.String[] getValuesToBeChecked()
          gets the value of the element(s) in the group which should be checked by default
 void reset()
          resets all attributes of the element back to a blank state
 void setValuesToBeChecked(java.lang.String[] x)
          specifies which element(s) in this group should be checked by default.
 void write()
          writes a group of checkboxes to the given writer in the form <input type="checkbox" {attributes here}>>Text
 
Methods inherited from class com.raj.htmlForms.HtmlGroups
getDisplayAsColumn, getEntries, getValueToBeChecked, setDisplayAsColumn, setEntries, setValueToBeChecked
 
Methods inherited from class com.raj.htmlForms.HtmlInput
getAccessKey, getDisabled, getReadOnly, getSize, getValue, isDisabled, setAccessKey, setReadOnly, setSize, setValue, toString
 
Methods inherited from class com.raj.htmlForms.HtmlFormElement
getDir, getId, getLang, getName, getOnBlur, getOnClick, getOnDblClick, getOnFocus, getOnKeyDown, getOnKeyPress, getOnKeyUp, getOnMouseDown, getOnMouseMove, getOnMouseOut, getOnMouseOver, getOnMouseUp, getOnSelect, getStyle, getTabIndex, getTheClass, getTitle, getXhtml, setDir, setId, setLang, setName, setOnBlur, setOnClick, setOnDblClick, setOnFocus, setOnKeyDown, setOnKeyPress, setOnKeyUp, setOnMouseDown, setOnMouseMove, setOnMouseOut, setOnMouseOver, setOnMouseUp, setOnSelect, setStyle, setStyle, setTabIndex, setTheClass, setTitle, setXhtml
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

HtmlCheckBoxGroup

public HtmlCheckBoxGroup(java.io.Writer w)
Minimal constructor for any form element. All other attributes can be added by the appropriate setter method. This follows the standard Java convention for attributes, so the attribute foo becomes setFoo(). The attribute names can be found at the W3C HTML reference or many other places on the web.

Parameters:
w - the Writer to which all the data will be written out
See Also:
W3C Reference for forms

HtmlCheckBoxGroup

public HtmlCheckBoxGroup(java.io.Writer w,
                         boolean x,
                         java.lang.String n)
Constructor that sets the writer and name and a boolean which determines whether or not XHTML will be written

Parameters:
w - the Writer to which all the data will be written out
x - if true, XHTML will be written, else false
n - the name of this element

HtmlCheckBoxGroup

public HtmlCheckBoxGroup(java.io.Writer w,
                         java.lang.String n)
Constructor that just sets the name of the element

Parameters:
w - the Writer to which all the data will be written out
n - the name of this element
See Also:
W3C Reference for forms

HtmlCheckBoxGroup

public HtmlCheckBoxGroup(java.io.Writer w,
                         java.lang.String n,
                         java.util.Map e)
Constructor that sets the name of the element and the entries

Parameters:
w - the Writer to which all the data will be written out
n - the name of this element
e - the entries that will be written to the page
See Also:
W3C Reference for forms

HtmlCheckBoxGroup

public HtmlCheckBoxGroup(java.io.Writer w,
                         java.lang.String n,
                         java.util.Map e,
                         java.lang.String c)
Constructor that sets the name of the element and the entries

Parameters:
w - the Writer to which all the data will be written out
n - the name of this element
e - the entries that will be written to the page
c - the key that should be checked by default
See Also:
W3C Reference for forms
Method Detail

setValuesToBeChecked

public void setValuesToBeChecked(java.lang.String[] x)
specifies which element(s) in this group should be checked by default. This string[] should match the value of some of the elements in the group. If no matches are found then no entry will be checked


getValuesToBeChecked

public java.lang.String[] getValuesToBeChecked()
gets the value of the element(s) in the group which should be checked by default


reset

public void reset()
Description copied from class: HtmlFormElement
resets all attributes of the element back to a blank state

Overrides:
reset in class HtmlGroups

write

public void write()
writes a group of checkboxes to the given writer in the form <input type="checkbox" {attributes here}>>Text

Specified by:
write in class HtmlFormElement