Class semper.preferences.PrefFieldCheckBox

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class semper.preferences.PrefFieldCheckBox

java.lang.Object
   |
   +----semper.preferences.PrefField
           |
           +----semper.preferences.PrefFieldCheckBox

public class PrefFieldCheckBox
extends PrefField

This field is a checkbox with an information string. It is a subclass of the PrefField abstract class.

Version:: $Revision: 1.8 $ $Date: 1997/01/17 19:53:06 $
Author:: Louis Salvail (CWI)
See Also:: PrefFieldString, PrefFieldLabel, PrefFieldChoice, PrefFieldNegotiable

PrefFieldCheckBox(): constructor for newInstance().
PrefFieldCheckBox(String, String, boolean): Constructor for fields looking like a checkbox with defaults constraints.
PrefFieldCheckBox(String, String, boolean, GridBagConstraints): Constructor for fields looking like a checkbox.

applyModification(): Applies the modification to the internal representation of the state of this checkbox.
cancel(): Cancel user's change.
getLabel(): This return the label associated with this checkbox.
getValue(): Set the chexkbox state.
isModified(): Tells if the state of this checkbox has been changed by the user.
isOK(): Returns always true.
myStreamSize(): Returns the size of the stream that would hold the externalized form of this field.
readObject(StreamInputInterface): Internalizes this field.
setValue(boolean): Set the chexkbox state.
setValue(Boolean): Set the chexkbox state.
setValue(Object): Set the chexkbox state.
showme(PrefFrame): This adds the approriate checkbox to a frame.
writeObject(StreamOutputInterface): Externalizes this field.

PrefFieldCheckBox

  public PrefFieldCheckBox(String fieldname,
                           String cbLabel,
                           boolean startval,
                           GridBagConstraints constraints)

Constructor for fields looking like a checkbox.

Parameters:: fieldname - is the string by wich this field is accessed through the preferences manager.; cbLabel - is the string appearing at right of the current check box.; startval - is the starting value.; constraints - is the set of GridBagConstraints for that component.
Returns:: the new checkbox field object.
See Also:: GridBagConstraints

PrefFieldCheckBox

  public PrefFieldCheckBox(String fieldname,
                           String cbLabel,
                           boolean startval)

Constructor for fields looking like a checkbox with defaults constraints.

Parameters:: fieldname - is the string by wich this field is accessed through the preferences manager.; cbLabel - is the string appearing at right of the current check box.; startval - is the starting value.
Returns:: the new object.
See Also:: GridBagConstraints

PrefFieldCheckBox

  public PrefFieldCheckBox()

constructor for newInstance().

Returns:: a new empty object.

showme

  public void showme(PrefFrame p)

This adds the approriate checkbox to a frame.

Parameters:: p - is the frame where the object will be shown.
Returns:: none.
Overrides:: showme in class PrefField

getValue

  public Object getValue()

Set the chexkbox state.

Parameters:: newval - is the boolean state of this checkbox.
Returns:: none.
Overrides:: getValue in class PrefField

setValue

  public void setValue(Object newval)

Set the chexkbox state.

Parameters:: newval - is the boolean state of this checkbox.
Returns:: none.
Overrides:: setValue in class PrefField

setValue

  public void setValue(boolean newval)

Set the chexkbox state.

Parameters:: newval - is the boolean state of this checkbox.
Returns:: none.

setValue

  public void setValue(Boolean newval)

Set the chexkbox state.

Parameters:: newval - is the boolean state of this checkbox.
Returns:: none.

getLabel

  public String getLabel()

This return the label associated with this checkbox.

Returns:: the label.

isModified

  public boolean isModified()

Tells if the state of this checkbox has been changed by the user.

Returns:: true iff the state has changed.
Overrides:: isModified in class PrefField

applyModification

  public boolean applyModification()

Applies the modification to the internal representation of the state of this checkbox.

Returns:: true iff the modification are allowed. (always true here)
Overrides:: applyModification in class PrefField

isOK

  public boolean isOK()

Returns always true.

Returns:: true.
Overrides:: isOK in class PrefField

cancel

  public void cancel()

Cancel user's change.

Returns:: none.
Overrides:: cancel in class PrefField

myStreamSize

  public int myStreamSize() throws StreamIOException

Returns the size of the stream that would hold the externalized form of this field.

Returns:: the size of the stream in bytes
Overrides:: myStreamSize in class PrefField
See Also:: Streamable

readObject

  public void readObject(StreamInputInterface stream) throws StreamIOException

Internalizes this field.

Parameters:: stream - is the stream of data the object state is retrieved from
Returns:: none.
Overrides:: readObject in class PrefField
See Also:: Streamable

writeObject

  public void writeObject(StreamOutputInterface stream) throws StreamIOException

Externalizes this field.

Parameters:: stream - is the stream of data the object state is recorded in
Returns:: none
Overrides:: writeObject in class PrefField
See Also:: Streamable

All Packages  Class Hierarchy  This Package  Previous  Next  Index