com.bea.wli.sb.transports.ui
Class TransportUIFactory

java.lang.Object
  com.bea.wli.sb.transports.ui.TransportUIFactory

public class TransportUIFactory
extends Object

This class provides factory methods for creating a Transport Edit Field and different kinds of Transport UI objects associated with the field. It also provides some helper methods for accessing values in these objects.

Nested Class Summary

static class	TransportUIFactory.BrowserTextBoxObject Browser textbox object
static class	TransportUIFactory.CheckBoxObject checkbox object
static class	TransportUIFactory.ConfirmationObject confirmation object
static class	TransportUIFactory.DynamicTableObject Dynamic table object
static class	TransportUIFactory.ExpandableRowObject Expandable Row Object
static class	TransportUIFactory.ExpandableTableObject Expandable Table Object
static class	TransportUIFactory.HintTextAreaObject A TextArea object with a hint above it
static class	TransportUIFactory.HintTextBoxObject A TextBox object with a little hint above it.
static class	TransportUIFactory.Option
static class	TransportUIFactory.PasswordObject password object
static class	TransportUIFactory.SelectObject select object
static class	TransportUIFactory.SimpleCell Simple Cell Object
static class	TransportUIFactory.SimpleRowObject Simple Row Object
static class	TransportUIFactory.SimpleTableObject Simple Table Object
static class	TransportUIFactory.TextAreaObject textarea object
static class	TransportUIFactory.TextBoxObject A simple text box input object.
static interface	TransportUIFactory.TransportUIObject Marker interface.

Field Summary

static int	TYPE_BROWSER_TEXTBOX
static int	TYPE_CHECKBOX
static int	TYPE_CONFIRM
static int	TYPE_DYN_TABLE
static int	TYPE_EXPAND_TABLE
static int	TYPE_HINT_TEXTAREA
static int	TYPE_HINT_TEXTBOX
static int	TYPE_PASSWORD
static int	TYPE_SELECT
static int	TYPE_SIMPLE_TABLE
static int	TYPE_TEXTAREA
static int	TYPE_TEXTBOX

Method Summary

static TransportUIFactory.BrowserTextBoxObject	createBrowserTextBox(String value, int size, String typeId) Creates a browser textbox object.
static TransportUIFactory.BrowserTextBoxObject	createBrowserTextBox(String value, int size, String typeId, boolean hasEvent) Creates a browser textbox object.
static TransportUIFactory.BrowserTextBoxObject	createBrowserTextBox(String value, int size, String typeId, boolean hasEvent, ResourceQuery resourceQuery) Creates a browser textbox object.
static TransportUIFactory.BrowserTextBoxObject	createBrowserTextBox(String value, String typeId) Creates a browser textbox object.
static TransportUIFactory.CheckBoxObject	createCheckbox(boolean checked) Creates a checkbox object.
static TransportUIFactory.CheckBoxObject	createCheckbox(String value, boolean checked, boolean hasEvent) Creates a checkbox object that posts an update event back to the transport provider when it changes.
static TransportUIFactory.ConfirmationObject	createConfirmation(String message, boolean confirmed) Creates a confirmation object.
static TransportUIFactory.DynamicTableObject	createDynamicTable(String[] headers, TransportUIFactory.TextBoxObject[] uiobjects) Creates a dynamic table object.
static TransportUIFactory.DynamicTableObject	createDynamicTable(String[] headers, TransportUIFactory.TextBoxObject[] uiobjects, List<String[]> rows) Creates a dynamic table object.
static TransportEditField	createEditField(String name, String label, String description, boolean isrequired, TransportUIFactory.TransportUIObject object) Creates a transport edit field.
static TransportEditField	createEditField(String name, String label, String description, TransportUIFactory.TransportUIObject object) Creates a transport edit field.
static TransportUIFactory.ExpandableTableObject	createExpandableTableObject(List<TransportUIFactory.ExpandableRowObject> rows, String checkboxDescription) Creates an expandable table object.
static TransportUIFactory.HintTextAreaObject	createHintTextArea(String value, String hint, int size, int numRows, boolean readOnly) Creates a hint textarea object.
static TransportUIFactory.HintTextBoxObject	createHintTextBox(String value, String hint, int size) Creates a hint textbox object.
static TransportUIFactory.PasswordObject	createPassword(String value) Creates a password object.
static TransportUIFactory.PasswordObject	createPassword(String value, int size) Creates a password object.
static TransportUIFactory.SelectObject	createSelectObject(String[] values, String[] formattedValues, String selected, int displayMode, boolean hasEvent) Creates a select object.
static TransportUIFactory.SelectObject	createSelectObject(TransportUIFactory.Option[] options, String selected, int displayMode, boolean hasEvent) Creates a select object.
static TransportUIFactory.SimpleTableObject	createSimpleTableObject(String[] headers, List<TransportUIFactory.SimpleRowObject> rows) Creates a simple table object.
static TransportUIFactory.SimpleTableObject	createSimpleTableObject(String[] headers, List<TransportUIFactory.SimpleRowObject> rows, String width) Creates a simple table object.
static TransportUIFactory.TextAreaObject	createTextArea(String value, int size, int numRows, boolean readOnly) Creates a textarea object.
static TransportUIFactory.TextBoxObject	createTextBox(String value) Creates a textbox object.
static TransportUIFactory.TextBoxObject	createTextBox(String value, int size) Creates a textbox object with a specified size.
static TransportUIFactory.TextBoxObject	createTextBox(String value, int size, boolean readOnly) Creates a textbox object with associated attributes.
static boolean	getBooleanValue(Map<String,TransportUIFactory.TransportUIObject> map, String name) Returns the value of the named field as a boolean.
static int	getIntValue(Map<String,TransportUIFactory.TransportUIObject> map, String name) Returns the value of the named field as an integer.
static String	getStringValue(Map<String,TransportUIFactory.TransportUIObject> map, String name) Returns the value of the named field as a string.
static String	getStringValue(TransportUIFactory.TransportUIObject uiobject) Returns the value of the UI object as a string.
static List<String[]>	getStringValues(Map<String,TransportUIFactory.TransportUIObject> map, String name) Returns the list of string values for the named field.
static List<String[]>	getStringValues(TransportUIFactory.TransportUIObject uiobject) Returns the list of string values for the TransportUIObject; This is typically used for retrieving values from the table objects.
static void	setValue(TransportUIFactory.TransportUIObject uiObject, String value) Sets the value of a transport UI object.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_TEXTBOX

public static final int TYPE_TEXTBOX

See Also:

Constant Field Values

TYPE_CHECKBOX

public static final int TYPE_CHECKBOX

See Also:

Constant Field Values

TYPE_SELECT

public static final int TYPE_SELECT

See Also:

Constant Field Values

TYPE_PASSWORD

public static final int TYPE_PASSWORD

See Also:

Constant Field Values

TYPE_DYN_TABLE

public static final int TYPE_DYN_TABLE

See Also:

Constant Field Values

TYPE_CONFIRM

public static final int TYPE_CONFIRM

See Also:

Constant Field Values

TYPE_BROWSER_TEXTBOX

public static final int TYPE_BROWSER_TEXTBOX

See Also:

Constant Field Values

TYPE_TEXTAREA

public static final int TYPE_TEXTAREA

See Also:

Constant Field Values

TYPE_HINT_TEXTBOX

public static final int TYPE_HINT_TEXTBOX

See Also:

Constant Field Values

TYPE_EXPAND_TABLE

public static final int TYPE_EXPAND_TABLE

See Also:

Constant Field Values

TYPE_SIMPLE_TABLE

public static final int TYPE_SIMPLE_TABLE

See Also:

Constant Field Values

TYPE_HINT_TEXTAREA

public static final int TYPE_HINT_TEXTAREA

See Also:

Constant Field Values

Method Detail

createEditField

public static TransportEditField createEditField(String name,
                                                 String label,
                                                 String description,
                                                 TransportUIFactory.TransportUIObject object)

Creates a transport edit field.

Parameters:

name - identifies the field.

label - label that displays on the form.

description - tool tip text that appears on a mouseover.

object - transport UI object associated with this field.

Returns:

a new transport edit field.

createEditField

public static TransportEditField createEditField(String name,
                                                 String label,
                                                 String description,
                                                 boolean isrequired,
                                                 TransportUIFactory.TransportUIObject object)

Creates a transport edit field. If a field is required then the user must enter data for that field, otherwise a validation error message will be displayed and prevent the form submission.

Parameters:

name - identifies the field.

label - label that displays on the form.

description - tool tip text that appears on a mouseover.

isrequired - indicates if this is a required field.

object - transport UI object associated with this field.

Returns:

a new transport edit field.

createTextBox

public static TransportUIFactory.TextBoxObject createTextBox(String value)

Creates a textbox object.

Parameters:

value - the initial value for the textbox.

Returns:

a new textbox object.

createTextBox

public static TransportUIFactory.TextBoxObject createTextBox(String value,
                                                             int size)

Creates a textbox object with a specified size.

Parameters:

value - the initial value for the textbox.

size - the size of the textbox.

Returns:

a new textbox object.

createTextBox

public static TransportUIFactory.TextBoxObject createTextBox(String value,
                                                             int size,
                                                             boolean readOnly)

Creates a textbox object with associated attributes.

Parameters:

value - the initial value for the textbox.

size - the size of the textbox.

readOnly - if true the textbox is disabled for input.

Returns:

a new textbox object.

createCheckbox

public static TransportUIFactory.CheckBoxObject createCheckbox(boolean checked)

Creates a checkbox object.

Parameters:

checked - the initial state for the checkbox.

Returns:

a new checkbox object.

createCheckbox

public static TransportUIFactory.CheckBoxObject createCheckbox(String value,
                                                               boolean checked,
                                                               boolean hasEvent)

Creates a checkbox object that posts an update event back to the transport provider when it changes.

Parameters:

value - the value associated with the checkbox.

checked - the initial state for the checkbox.

hasEvent - true indicates that an update event is to be posted back to the transport provider when the checkbox is changed.

Returns:

the new checkbox object.

createSelectObject

public static TransportUIFactory.SelectObject createSelectObject(String[] values,
                                                                 String[] formattedValues,
                                                                 String selected,
                                                                 int displayMode,
                                                                 boolean hasEvent)

Creates a select object.

Parameters:

values - the actual values for each of the options.

formattedValues - the displayed text for each of the options.

selected - the default selection.

displayMode - the type of display presentation (list or radio buttons).

hasEvent - true indicates that an update event is to be posted back to the transport provider when the checkbox is changed.

Returns:

the new checkbox object.

createSelectObject

public static TransportUIFactory.SelectObject createSelectObject(TransportUIFactory.Option[] options,
                                                                 String selected,
                                                                 int displayMode,
                                                                 boolean hasEvent)

Creates a select object.

Parameters:

options - the values and displayed text for the options.

selected - the default selection.

displayMode - the type of display presentation (list or radio buttons).

hasEvent - true indicates that an update event is to be posted back to the transport provider when the checkbox is changed.

Returns:

the new checkbox object.

createPassword

public static TransportUIFactory.PasswordObject createPassword(String value)

Creates a password object.

Parameters:

value - the initial value for the password.

Returns:

the new password object.

createPassword

public static TransportUIFactory.PasswordObject createPassword(String value,
                                                               int size)

Creates a password object.

Parameters:

value - the initial value for the password.

size - the size of the password input field.

Returns:

the new password object.

createDynamicTable

public static TransportUIFactory.DynamicTableObject createDynamicTable(String[] headers,
                                                                       TransportUIFactory.TextBoxObject[] uiobjects)

Creates a dynamic table object. A dynamic table consists a table display with a variable number of rows and columns. It also has an input area associated with the table for adding new rows. Existing rows in the table can be deleted by clicking on a delete icon on each row.

Parameters:

headers - the labels for each column in the table

uiobjects - input textbox objects used for adding new rows.

Returns:

the new dynamic table object.

createDynamicTable

public static TransportUIFactory.DynamicTableObject createDynamicTable(String[] headers,
                                                                       TransportUIFactory.TextBoxObject[] uiobjects,
                                                                       List<String[]> rows)

Creates a dynamic table object. A dynamic table consists a table display with a variable number of rows and columns. It also has an input area associated with the table for adding new rows. Existing rows in the table can be deleted by clicking on a delete icon on each row.

Parameters:

headers - the labels for each column in the table

uiobjects - input textbox objects used for adding new rows.

rows - the initial list of rows in the table.

Returns:

the new dynamic table object.

createConfirmation

public static TransportUIFactory.ConfirmationObject createConfirmation(String message,
                                                                       boolean confirmed)

Creates a confirmation object. A confirmation object is a browser popup message box. If the confirm state is false then a popup mesage box is displayed and the state is changed to true after the user dismisses the popup.

Parameters:

message - text to be displayed in the popup.

confirmed - initial state for the confirmation object.

Returns:

a new confirmation object.

createBrowserTextBox

public static TransportUIFactory.BrowserTextBoxObject createBrowserTextBox(String value,
                                                                           String typeId)

Creates a browser textbox object. This is used to display a resource chooser popup window. The initial form display consists of a textbox for the returned selection and a browse button for showing the chooser dialog.

Parameters:

value - the initial value of the selected resource.

typeId - identifies the type of resource to be shown.

Returns:

a new browser textbox object.

createBrowserTextBox

public static TransportUIFactory.BrowserTextBoxObject createBrowserTextBox(String value,
                                                                           int size,
                                                                           String typeId)

Creates a browser textbox object. This is used to display a resource chooser popup window. The initial form display consists of a textbox for the returned selection and a browse button for showing the chooser dialog.

Parameters:

value - the initial value of the selected resource.

size - the size of the selection textbox field.

typeId - identifies the type of resource to be shown.

Returns:

a new browser textbox object.

createBrowserTextBox

public static TransportUIFactory.BrowserTextBoxObject createBrowserTextBox(String value,
                                                                           int size,
                                                                           String typeId,
                                                                           boolean hasEvent)

Creates a browser textbox object. This is used to display a resource chooser popup window. The initial form display consists of a textbox for the returned selection and a browse button for showing the chooser dialog.

Parameters:

value - the initial value of the selected resource.

size - the size of the selection textbox field.

typeId - identifies the type of resource to be shown.

hasEvent - true indicates that an update event is to be posted back to the transport provider when the selection textbox is changed.

Returns:

a new browser textbox object.

createBrowserTextBox

public static TransportUIFactory.BrowserTextBoxObject createBrowserTextBox(String value,
                                                                           int size,
                                                                           String typeId,
                                                                           boolean hasEvent,
                                                                           ResourceQuery resourceQuery)

Creates a browser textbox object. This is used to display a resource chooser popup window. The initial form display consists of a textbox for the returned selection and a browse button for showing the chooser dialog.

Parameters:

value - the initial value of the selected resource.

size - the size of the selection textbox field.

typeId - identifies the type of resource to be shown.

hasEvent - true indicates that an update event is to be posted back to the transport provider when the selection textbox is changed.

resourceQuery - query used to filter the resource chooser.

Returns:

a new browser textbox object.

createTextArea

public static TransportUIFactory.TextAreaObject createTextArea(String value,
                                                               int size,
                                                               int numRows,
                                                               boolean readOnly)

Creates a textarea object.

Parameters:

value - the initial value of the textarea.

size - the width of the textarea.

numRows - the number of rows in the textarea.

readOnly - if true the textarea is disabled for input.

Returns:

a new textarea object.

createHintTextBox

public static TransportUIFactory.HintTextBoxObject createHintTextBox(String value,
                                                                     String hint,
                                                                     int size)

Creates a hint textbox object.

Parameters:

value - the initial value of the textbox.

hint - a short descriptive text hint to display near the textbox.

size - the size of the textbox.

Returns:

a new hint textbox object.

createHintTextArea

public static TransportUIFactory.HintTextAreaObject createHintTextArea(String value,
                                                                       String hint,
                                                                       int size,
                                                                       int numRows,
                                                                       boolean readOnly)

Creates a hint textarea object.

Parameters:

value - the initial value of the textarea.

hint - a short descriptive text hint to display near the text area.

size - the width of the textarea.

numRows - the number of rows in the textarea.

readOnly - if true the textarea is disabled for input.

Returns:

a new hint textarea object.

createExpandableTableObject

public static TransportUIFactory.ExpandableTableObject createExpandableTableObject(List<TransportUIFactory.ExpandableRowObject> rows,
                                                                                   String checkboxDescription)

Creates an expandable table object. An expandable table object contains individual rows that can each be expanded and collapsed. Each expanded row has a select checkbox and an associated list of transport edit fields that are shown when the row is expanded.

Parameters:

rows - the list of expandable rows in the table.

checkboxDescription - tool tip descriptive text displayed when the mouse hovers over the checkbox.

Returns:

a new expandable table object.

createSimpleTableObject

public static TransportUIFactory.SimpleTableObject createSimpleTableObject(String[] headers,
                                                                           List<TransportUIFactory.SimpleRowObject> rows)

Creates a simple table object.

Parameters:

headers - the labels for each column in the table

rows - the list of rows in the table.

Returns:

a new simple table object.

createSimpleTableObject

public static TransportUIFactory.SimpleTableObject createSimpleTableObject(String[] headers,
                                                                           List<TransportUIFactory.SimpleRowObject> rows,
                                                                           String width)

Creates a simple table object.

Parameters:

headers - the labels for each column in the table

rows - the list of rows in the table.

width - the HTML width of the table.

Returns:

a new simple table object.

getStringValue

public static String getStringValue(TransportUIFactory.TransportUIObject uiobject)

Returns the value of the UI object as a string.

Parameters:

uiobject - the UI object whose value is to be retrieved

Returns:

the string value of the given UI object.

getStringValue

public static String getStringValue(Map<String,TransportUIFactory.TransportUIObject> map,
                                    String name)

Returns the value of the named field as a string.

Parameters:

map - the map of field names to TransportUIObjects (see TransportEditField.getObjectMap(...)).

name - the name of the field whose value is to be retrieved.

Returns:

the string value of the named field.

getIntValue

public static int getIntValue(Map<String,TransportUIFactory.TransportUIObject> map,
                              String name)

Returns the value of the named field as an integer. If the internal value is null or empty a 0 is returned. If the internal value is not a valid integer then a NumberFormatException is thrown.

Parameters:

map - the map of field names to TransportUIObjects (see TransportEditField.getObjectMap(...)).

name - the name of the field whose value is to be retrieved.

Returns:

the integer value of the named field.

getBooleanValue

public static boolean getBooleanValue(Map<String,TransportUIFactory.TransportUIObject> map,
                                      String name)

Returns the value of the named field as a boolean.

Parameters:

map - the map of field names to TransportUIObjects (see TransportEditField.getObjectMap(...)).

name - the name of the field whose value is to be retrieved.

Returns:

the boolean value of the named field.

getStringValues

public static List<String[]> getStringValues(TransportUIFactory.TransportUIObject uiobject)

Returns the list of string values for the TransportUIObject; This is typically used for retrieving values from the table objects.

getStringValues

public static List<String[]> getStringValues(Map<String,TransportUIFactory.TransportUIObject> map,
                                             String name)

Returns the list of string values for the named field. This is typically used for retrieving values from the table objects.

Parameters:

map - the map of field names to TransportUIObjects (see TransportEditField.getObjectMap(...)).

name - the name of the field whose value is to be retrieved.

Returns:

the list of string values for the named field.

setValue

public static void setValue(TransportUIFactory.TransportUIObject uiObject,
                            String value)

Sets the value of a transport UI object.

Parameters:

uiObject - the TransportUIObject whose value is to be retrieved.

value - the string value for the object.