ucar.unidata.ui

Class HttpFormEntry

java.lang.Object

ucar.unidata.ui.HttpFormEntry

public class HttpFormEntry
extends java.lang.Object

Class HttpFormEntry Represents a http form post input field.

Version:

$Revision: 1.18 $

Author:

IDV Development Team

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_AREA Multi-line input field type
static int	TYPE_FILE Just a label in the gui
static int	TYPE_HIDDEN Hidden input field type
static int	TYPE_INPUT Normal input field type
static int	TYPE_LABEL Just a label in the gui

Constructor Summary

Constructors

Constructor and Description
HttpFormEntry(int type, java.lang.String name, java.lang.String label) Create the entry
HttpFormEntry(int type, java.lang.String name, java.lang.String label, int rows, int cols) Create the entry
HttpFormEntry(int type, java.lang.String name, java.lang.String label, java.lang.String value) Create the entry
HttpFormEntry(int type, java.lang.String name, java.lang.String label, java.lang.String value, boolean required) Create the entry
HttpFormEntry(int type, java.lang.String name, java.lang.String label, java.lang.String value, int rows, int cols) Create the entry
HttpFormEntry(int type, java.lang.String name, java.lang.String label, java.lang.String value, int rows, int cols, boolean required) Create the entry
HttpFormEntry(java.lang.String name, java.lang.String label) Create the entry
HttpFormEntry(java.lang.String name, java.lang.String fileName, byte[] bytes) Create an entry that already holds the byte contents of a file.
HttpFormEntry(java.lang.String name, java.lang.String label, java.lang.String value)

Method Summary

Modifier and Type	Method and Description
void	addToGui(java.util.List guiComps) Add the label/gui component into the list of components
void	browse(javax.swing.JTextField fld) Open a file browser associated with the text field
static boolean	checkEntries(java.util.List<HttpFormEntry> entries) Check the entries to make sure they have been filled in
static java.lang.String[]	doPost(java.util.List<HttpFormEntry> entries, java.lang.String urlPath) Post the given entries tot he given url
byte[]	getBytes() Get the bytes
java.lang.String	getLabel() Get the label
java.lang.String	getName() Get the name
java.lang.String	getValue() Get the value the user entered.
static HttpFormEntry	hidden(java.lang.String name, java.lang.String value)
static javax.swing.JComponent	makeUI(java.util.List<HttpFormEntry> entries) Create the GUI from the list of entries
boolean	ok() Is this entry ok.
boolean	okToPost() Post the file
void	setValue(java.lang.String newValue) Set the text value to the given newValue
static boolean	showUI(java.util.List<HttpFormEntry> entries, javax.swing.JComponent extraTop, javax.swing.JComponent extraBottom, javax.swing.JDialog dialog, boolean shouldDoBusyWait) Show the UI in a modeful dialog.
static boolean	showUI(java.util.List<HttpFormEntry> entries, java.lang.String title, java.awt.Window window, javax.swing.JComponent extraTop) Show the UI in a modeful dialog.
static boolean	showUI(java.util.List<HttpFormEntry> entries, java.lang.String title, java.awt.Window parent, javax.swing.JComponent extraTop, javax.swing.JComponent extraBottom) Show the UI in a modeful dialog.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_HIDDEN

public static final int TYPE_HIDDEN

Hidden input field type

See Also:

Constant Field Values

TYPE_INPUT

public static final int TYPE_INPUT

Normal input field type

See Also:

Constant Field Values

TYPE_AREA

public static final int TYPE_AREA

Multi-line input field type

See Also:

Constant Field Values

TYPE_LABEL

public static final int TYPE_LABEL

Just a label in the gui

See Also:

Constant Field Values

TYPE_FILE

public static final int TYPE_FILE

Just a label in the gui

See Also:

Constant Field Values

Constructor Detail

HttpFormEntry

public HttpFormEntry(java.lang.String name,
                     java.lang.String fileName,
                     byte[] bytes)

Create an entry that already holds the byte contents of a file. Having an entry like this will result in a multi-part post

Parameters:

name - The name of the file

fileName - filename - this is the name that is posted

bytes - the bytes

HttpFormEntry

public HttpFormEntry(java.lang.String name,
                     java.lang.String label,
                     java.lang.String value)

HttpFormEntry

public HttpFormEntry(java.lang.String name,
                     java.lang.String label)

Create the entry

Parameters:

name - The name

label - The label

HttpFormEntry

public HttpFormEntry(int type,
                     java.lang.String name,
                     java.lang.String label)

Create the entry

Parameters:

type - The type of this entry

name - The name

label - The label

HttpFormEntry

public HttpFormEntry(int type,
                     java.lang.String name,
                     java.lang.String label,
                     java.lang.String value)

Create the entry

Parameters:

type - The type of this entry

name - The name

label - The label

value - Initial value

HttpFormEntry

public HttpFormEntry(int type,
                     java.lang.String name,
                     java.lang.String label,
                     java.lang.String value,
                     boolean required)

Create the entry

Parameters:

type - The type of this entry

name - The name

label - The label

value - Initial value

required - Is this entry required

HttpFormEntry

public HttpFormEntry(int type,
                     java.lang.String name,
                     java.lang.String label,
                     int rows,
                     int cols)

Create the entry

Parameters:

type - The type of this entry

name - The name

label - The label

rows - How may rows in the text area

cols - How many columns in the text area

HttpFormEntry

public HttpFormEntry(int type,
                     java.lang.String name,
                     java.lang.String label,
                     java.lang.String value,
                     int rows,
                     int cols)

Create the entry

Parameters:

type - The type of this entry

name - The name

label - The label

value - Initial value

rows - How many rows

cols - How many cols

HttpFormEntry

public HttpFormEntry(int type,
                     java.lang.String name,
                     java.lang.String label,
                     java.lang.String value,
                     int rows,
                     int cols,
                     boolean required)

Create the entry

Parameters:

type - The type of this entry

name - The name

label - The label

value - Initial value

rows - How many rows

cols - How many cols

required - Is this entry required

Method Detail

hidden

public static HttpFormEntry hidden(java.lang.String name,
                                   java.lang.String value)

ok

public boolean ok()

Is this entry ok. That is, has their been input if it is required

Returns:

Is ok

addToGui

public void addToGui(java.util.List guiComps)

Add the label/gui component into the list of components

Parameters:

guiComps - A list.

browse

public void browse(javax.swing.JTextField fld)

Open a file browser associated with the text field

Parameters:

fld - the JTextField

getValue

public java.lang.String getValue()

Get the value the user entered.

Returns:

The input value

setValue

public void setValue(java.lang.String newValue)

Set the text value to the given newValue

Parameters:

newValue - The new text

getName

public java.lang.String getName()

Get the name

Returns:

The name

getLabel

public java.lang.String getLabel()

Get the label

Returns:

The label

getBytes

public byte[] getBytes()

Get the bytes

Returns:

The bytes

makeUI

public static javax.swing.JComponent makeUI(java.util.List<HttpFormEntry> entries)

Create the GUI from the list of entries

Parameters:

entries - List of entries

Returns:

The gui

checkEntries

public static boolean checkEntries(java.util.List<HttpFormEntry> entries)

Check the entries to make sure they have been filled in

Parameters:

entries - list of entries

Returns:

false if some are not filled in.

showUI

public static boolean showUI(java.util.List<HttpFormEntry> entries,
                             java.lang.String title,
                             java.awt.Window window,
                             javax.swing.JComponent extraTop)

Show the UI in a modeful dialog. Note: this method should not be called from a swing process. It does a busy wait on the dialog and does not rely on the modality of the dialog to do its wait.

Parameters:

entries - List of entries

title - The dialog title

window - The parent window

extraTop - If non-null then this is added to the top of the gui. It allows you to provide a label, etc.

Returns:

Did user press ok

showUI

public static boolean showUI(java.util.List<HttpFormEntry> entries,
                             java.lang.String title,
                             java.awt.Window parent,
                             javax.swing.JComponent extraTop,
                             javax.swing.JComponent extraBottom)

Show the UI in a modeful dialog. Note: this method should not be called from a swing process. It does a busy wait on the dialog and does not rely on the modality of the dialog to do its wait.

Parameters:

entries - List of entries

title - The dialog title

parent - The parent window

extraTop - If non-null then this is added to the top of the gui. It allows you to provide a label, etc.

extraBottom - Like extraTop but on the bottom of the window

Returns:

Did user press ok

showUI

public static boolean showUI(java.util.List<HttpFormEntry> entries,
                             javax.swing.JComponent extraTop,
                             javax.swing.JComponent extraBottom,
                             javax.swing.JDialog dialog,
                             boolean shouldDoBusyWait)

Show the UI in a modeful dialog. Note: The calling method is responsible for disposing of the dialog. Also: This method should not be called from a swing process. It does a busy wait on the dialog and does not rely on the modality of the dialog to do its wait.

Parameters:

entries - List of entries

extraTop - If non-null then this is added to the top of the gui. It allows you to provide a label, etc.

extraBottom - Like extraTop but on the bottom of the window

dialog - the dialog

shouldDoBusyWait - true to wait

Returns:

Did user press ok

okToPost

public boolean okToPost()

Post the file

Returns:

true if posted

doPost

public static java.lang.String[] doPost(java.util.List<HttpFormEntry> entries,
                                        java.lang.String urlPath)

Post the given entries tot he given url

Parameters:

entries - The entries

urlPath - The url to post to

Returns:

2 element array. First element is non-null if there was an error. Second element is non-null if no error. This is the returned html.