org.apache.guacamole.form

Class Form

java.lang.Object

org.apache.guacamole.form.Form

public class Form
extends Object

Information which describes logical set of fields.

Constructor Summary

Constructors

Constructor and Description
Form() Creates a new Form object with no associated fields.
Form(String name, Collection<Field> fields) Creates a new Form object having the given name and containing the given fields.

Method Summary

Modifier and Type	Method and Description
Collection<Field>	getFields() Returns a mutable collection of the fields associated with this form.
String	getName() Returns the name of this form.
void	setFields(Collection<Field> fields) Sets the collection of fields associated with this form.
void	setName(String name) Sets the name of this form.

Methods inherited from class java.lang.Object

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

Constructor Detail

Form

public Form()

Creates a new Form object with no associated fields. The name is left unset as null. If no form name is provided, this form must not be used in the same context as another unnamed form.

Form

public Form(String name,
            Collection<Field> fields)

Creates a new Form object having the given name and containing the given fields.

Parameters:

name - A name which uniquely identifies this form.

fields - The fields to provided within the new Form.

Method Detail

getFields

public Collection<Field> getFields()

Returns a mutable collection of the fields associated with this form. Changes to this collection affect the fields exposed to the user.

Returns:

A mutable collection of fields.

setFields

public void setFields(Collection<Field> fields)

Sets the collection of fields associated with this form.

Parameters:

fields - The collection of fields to associate with this form.

getName

public String getName()

Returns the name of this form. Form names must uniquely identify each form.

Returns:

The name of this form, or null if the form has no name.

setName

public void setName(String name)

Sets the name of this form. Form names must uniquely identify each form.

Parameters:

name - The name to assign to this form.