Package com.bea.alsb.presentation

Class UIFactory

java.lang.Object
com.bea.alsb.presentation.UIFactory
All Implemented Interfaces:
Constants, oracle.tip.tools.presentation.uiobjects.sdk.Constants
public class UIFactory extends Object implements Constants
This class provides factory methods for creating Edit Field and different kinds of UI objects associated with the field. It also provides some helper methods for accessing values in these objects.

  • Constructor Details

    • UIFactory

      public UIFactory()

  • Method Details

    • createEditField

      public static EditField createEditField(String name, String label, String description, UIObject object)
      Creates a edit field.
      Parameters:
      name - identifies the field.
      label - label that displays on the form.
      description - tool tip text that appears on a mouseover.
      object - UI object associated with this field.
      Returns:
      a new edit field.

    • createEditField

      public static EditField createEditField(String name, String label, String description, boolean isrequired, UIObject object)
      Creates a 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 - UI object associated with this field.
      Returns:
      a new edit field.

    • createTextBox

      public static TextBoxObject createTextBox(String value)
      Creates a textbox object.
      Parameters:
      value - the initial value for the textbox.
      Returns:
      a new textbox object.

    • createTextBox

      public static 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 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 CheckBoxObject createCheckbox(boolean checked)
      Creates a checkbox object.
      Parameters:
      checked - the initial state for the checkbox.
      Returns:
      a new checkbox object.

    • createCheckbox

      public static CheckBoxObject createCheckbox(String value, boolean checked, boolean hasEvent)
      Creates a checkbox object that posts an update event back to the 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 provider when the checkbox is changed.
      Returns:
      the new checkbox object.

    • createSelectObject

      public static 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 provider when the checkbox is changed.
      Returns:
      the new checkbox object.

    • createSelectObject

      public static SelectObject createSelectObject(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 provider when the checkbox is changed.
      Returns:
      the new checkbox object.

    • createPassword

      public static PasswordObject createPassword(String value)
      Creates a password object.
      Parameters:
      value - the initial value for the password.
      Returns:
      the new password object.

    • createPassword

      public static 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 DynamicTableObject createDynamicTable(String[] headers, UIObject[] 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 UI objects used for adding new rows, currently textbox and list select box uiobjects are supported.
      Returns:
      the new dynamic table object.

    • createDynamicTable

      public static DynamicTableObject createDynamicTable(String[] headers, UIObject[] 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 UI objects used for adding new rows, currently textbox and list select box uiobjects are supported.
      rows - the initial list of rows in the table.
      Returns:
      the new dynamic table object.

    • createConfirmation

      public static 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 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 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 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 provider when the selection textbox is changed.
      Returns:
      a new browser textbox object.

    • createBrowserTextBox

      public static 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 provider when the selection textbox is changed.
      resourceQuery - query used to filter the resource chooser.
      Returns:
      a new browser textbox object.

    • createFileBrowser

      public static FileBrowserObject createFileBrowser(byte[] value)
      Creates a File browser dialog textbox object with text area to show the uploaded file contents. This is used to display a file browser dialog window. The initial form display consists of a textarea for the uploaded file contents and a file browse button to launch file chooser dialog.
      Parameters:
      value - the initial value of the uploaded file contents.
      Returns:
      a new File browser textbox with text area object.

    • createFileBrowser

      public static FileBrowserObject createFileBrowser(byte[] value, boolean hideTextArea)
      Creates a File browser dialog textbox object with text area to show the uploaded file contents. This is used to display a file browser dialog window. The initial form display consists of a textarea for the uploaded file contents and a file browse button to launch file chooser dialog.
      Parameters:
      value - the initial value of the uploaded file contents.
      hideTextArea - opetion to show or hide text area
      Returns:
      a new File browser textbox with text area object.

    • createFileBrowser

      public static FileBrowserObject createFileBrowser(byte[] value, int size, boolean hideTextArea, int rowSize, int columnSize, boolean hasEvent)
      Creates a File browser dialog textbox object with text area to show the uploaded file contents. This is used to display a file browser dialog window. The initial form display consists of a textarea for the uploaded file contents and a file browse button to launch file chooser dialog.
      Parameters:
      value - the initial value of the uploaded file contents.
      size - the size of the selection textbox field.
      hideTextArea - opetion to show or hide text area
      rowSize - the row size of the text area field.
      columnSize - the column size of the selection ext area field.
      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.

    • createTextArea

      public static 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 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 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 ExpandableTableObject createExpandableTableObject(List<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 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 SimpleTableObject createSimpleTableObject(String[] headers, List<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 SimpleTableObject createSimpleTableObject(String[] headers, List<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(UIObject 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,UIObject> map, String name)
      Returns the value of the named field as a string.
      Parameters:
      map - the map of field names to UIObjects (see EditField.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,UIObject> 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 UIObjects (see EditField.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,UIObject> map, String name)
      Returns the value of the named field as a boolean.
      Parameters:
      map - the map of field names to UIObjects (see EditField.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(UIObject uiobject)
      Returns the list of string values for the UIObject; This is typically used for retrieving values from the table objects.

    • getStringValues

      public static List<String[]> getStringValues(Map<String,UIObject> 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 UIObjects (see EditField.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(UIObject uiObject, String value)
      Sets the value of a UI object.
      Parameters:
      uiObject - the UIObject whose value is to be retrieved.
      value - the string value for the object.