arlut.csd.JDialog

Class JDialogBuff

java.lang.Object

arlut.csd.JDialog.JDialogBuff

All Implemented Interfaces:

java.io.Serializable

public class JDialogBuff
extends java.lang.Object
implements java.io.Serializable

This class is a serializable description of a dialog object that a server is asking a client to present.

If you don't need to send a dialog definition object across an RMI link, you can just construct a DialogRsrc directly.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	cancelText
(package private) static boolean	debug
(package private) java.lang.String	imageName
(package private) java.lang.String	okText
(package private) java.util.Vector	resources
(package private) java.lang.StringBuffer	text
(package private) java.lang.String	title

Constructor Summary

Constructors

Constructor and Description
JDialogBuff(java.lang.String Title, java.lang.String Text) Constructor for JDialogBuff
JDialogBuff(java.lang.String Title, java.lang.String Text, java.lang.String OK, java.lang.String Cancel) Constructor with special "Ok" and "Cancel" strings
JDialogBuff(java.lang.String Title, java.lang.String Text, java.lang.String OK, java.lang.String Cancel, java.lang.String image) Constructor with special "Ok" and "Cancel" strings

Method Summary

Methods

Modifier and Type	Method and Description
void	addBoolean(java.lang.String string) Adds a labeled check box field
void	addBoolean(java.lang.String string, boolean value) Adds a labeled check box field
void	addChoice(java.lang.String label, java.util.Vector choices) Adds a choice field to the dialog
void	addChoice(java.lang.String label, java.util.Vector choices, java.lang.String selectedValue) Adds a choice field to the dialog
void	addDate(java.lang.String label, java.util.Date currentDate, java.util.Date maxDate) Adds a labeled date field
void	addMultiString(java.lang.String string, java.lang.String value) Adds a labeled multi-line text field
void	addPassword(java.lang.String label) Adds a text-hidden password string field to the dialog
void	addPassword(java.lang.String label, boolean isNew) Adds a text-hidden password string field to the dialog
void	addString(java.lang.String string) Adds a labeled text field
void	addString(java.lang.String string, java.lang.String value) Adds a labeled text field
void	appendText(java.lang.String text) Adds a newline and the provided text to the end of the text encoded in this dialog.
DialogRsrc	extractDialogRsrc(java.awt.Frame frame, java.lang.Class refClass) frame is an AWT Frame that can be used to format graphics for.
java.lang.String	getImageName() public accessor for our imageName, if we have one.
java.lang.String	getText() This is a convenience function for the server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

debug

static final boolean debug

See Also:

Constant Field Values

title

java.lang.String title

text

java.lang.StringBuffer text

okText

java.lang.String okText

cancelText

java.lang.String cancelText

imageName

java.lang.String imageName

resources

java.util.Vector resources

Constructor Detail

JDialogBuff

public JDialogBuff(java.lang.String Title,
           java.lang.String Text)

Constructor for JDialogBuff

Parameters:

Title - String for title of Dialog box.

Text - String for message at top of dialog box.

JDialogBuff

public JDialogBuff(java.lang.String Title,
           java.lang.String Text,
           java.lang.String OK,
           java.lang.String Cancel)

Constructor with special "Ok" and "Cancel" strings

Parameters:

Title - String for title of Dialog box.

Text - String for message at top of dialog box.

OK - String for Ok button

Cancel - String for Cancel button

JDialogBuff

public JDialogBuff(java.lang.String Title,
           java.lang.String Text,
           java.lang.String OK,
           java.lang.String Cancel,
           java.lang.String image)

Constructor with special "Ok" and "Cancel" strings

Parameters:

Title - String for title of Dialog box.

Text - String for message at top of dialog box.

OK - String for Ok button

Cancel - String for Cancel button

image - Filename of image to display next to text

Method Detail

extractDialogRsrc

public DialogRsrc extractDialogRsrc(java.awt.Frame frame,
                           java.lang.Class refClass)

frame is an AWT Frame that can be used to format graphics for.

refClass, if not null, serves is used as a reference point for finding the image resources specified by this JDialogBuff. The imageName will be looked for from the same place (a jar file or a classpath directory) that the refClass was pulled from. If refClass belongs to a Java package, the image will be looked for relative to that package in the jar file or classpath directory from which refClass was loaded.

If refClass is null, the class of the frame passed in will be used as the reference class. This is only useful if the frame is a custom subclass located in the jar or classpath directory from which we wish to load the image.

addString

public void addString(java.lang.String string)

Adds a labeled text field

Parameters:

string - String to use as the label

addString

public void addString(java.lang.String string,
             java.lang.String value)

Adds a labeled text field

Parameters:

string - String to use as the label

value - Initial value for string

addMultiString

public void addMultiString(java.lang.String string,
                  java.lang.String value)

Adds a labeled multi-line text field

Parameters:

string - String to use as the label

value - Initial value for string

addBoolean

public void addBoolean(java.lang.String string)

Adds a labeled check box field

Parameters:

string - String to use as the label

addBoolean

public void addBoolean(java.lang.String string,
              boolean value)

Adds a labeled check box field

Parameters:

string - String to use as the label

value - Initial value

addDate

public void addDate(java.lang.String label,
           java.util.Date currentDate,
           java.util.Date maxDate)

Adds a labeled date field

Parameters:

label - String to use as the label

currentDate - Date to initialize the date field to

maxDate - Latest date that the user may choose for this field.

addChoice

public void addChoice(java.lang.String label,
             java.util.Vector choices)

Adds a choice field to the dialog

Parameters:

label - String to use as the label

choices - Vector of Strings to add to the choice

addChoice

public void addChoice(java.lang.String label,
             java.util.Vector choices,
             java.lang.String selectedValue)

Adds a choice field to the dialog

Parameters:

label - String to use as the label

choices - Vector of Strings to add to the choice

addPassword

public void addPassword(java.lang.String label)

Adds a text-hidden password string field to the dialog

Parameters:

label - String to use as label

addPassword

public void addPassword(java.lang.String label,
               boolean isNew)

Adds a text-hidden password string field to the dialog

Parameters:

label - String to use as label

isNew - If true, the password field added to this dialog definition will be doubled to prompt the user to enter the password twice for initial validation. If false, the user will only have to enter his password once.

appendText

public void appendText(java.lang.String text)

Adds a newline and the provided text to the end of the text encoded in this dialog.

getText

public java.lang.String getText()

This is a convenience function for the server.

getImageName

public java.lang.String getImageName()

public accessor for our imageName, if we have one. Used by ReturnVal.merge().