AbstractPreferencesTransform

Constant specifying the ID to use for the preferences's HTML Form.

Constant specifying the name of the formal parameter for defining the level flag. Value is levelFlag.

Constant specifying the image for the upper left corner of the preferences.

Constant specifying the image for the upper right corner of the preferences.

Allowed value for the levelFlag formal parameter. Convenience flag to indicate all possible LEVEL values.
Value = 16777215

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the apply button.
Value = 2

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the apply to select box.
If missing the preferences will be saved to the current project only.
Value = 4

Allowed value for the levelFlag formal parameter. Specifies that the transform will render a form tag surrounding the whole output.
Value = 8

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the Load Defaults button.
Value = 8

Allowed value for the levelFlag formal parameter. Specifies that the transform will display the preferences section.
Value = 1

Specifies the ID to use for the preferences' HTML Form.
Allowed Values:
Any string allowed in an ID tag of an HTML form.
Usage:
This may be changed to execute some Javascript that needs to make reference to the preferences form with a specific name.

Indicates the level of information to use when displaying the preferences bean.
The information include the preferences section, the apply to select box and the load defaults button Default value is LEVEL_ALL

Specifies the image for the upper left corner of the preferences' frame.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on the Usage:
This may be changed to change the look and feel (i.e. color) of the preferences page.

Specifies the image for the upper right corner of the preferences' frame.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on the Usage:
This may be changed to change the look and feel (i.e. color) of all preferences pages.

Default empty constructor. Initialize formal parameters.

Returns the textual description of the transform

Returns the supported bean type. This abstract Transform supports all WebComponents so every sub-class should override this method to return the class of the Bean the Transform is expecting, for example:

 public class CustomReportClass extends AbstractAppTransform {

    public Class getSupportedBeanType() {
        //This Transform is expected to work only with a ReportBean,
        //therefore this method needs to return this class:
        return ReportBean.class;
    }

 }
 

Initialize the images to be used by this transform.

This method initialize the private and protected fields of the transform, such as width and height. It also invokes the initializeWebComponent, initializeImages and initializeCss methods.

Renders a combobox with the options to "Apply to current project" or to all projects

Renders the Form end tag

Renders the start of the Preference's Form. This method also renders the hidden inputs associated with the event

Renders a transform's image

Render individual preferences based on the name provided

If a preference was updated and there were no errors, this method shows a success message to the user.

Render the save message text that should be presented to the user once the saving has been successful.

Render a confirmation message to show updating is successful or error happened.

Generates the graphical output for the PreferencesBean when the bean is succesfull. It just renders a "Success" message but calls again transformForRequestWaitingForUserInput so the user might change Preferences again.

Transform when the status is WaitingForUserInputessful. Overwrites by showing the Preferences form.

Returns the ID to use for the form that contains the preferences inputs. This is the value of the formID formal parameter.

Returns the value of the preference with the given name. The value is automatically selected for the current level.

Returns the value of the preference with the given name, at the given level

Returns the current PreferencesBean

Check to see if the property comes in the request keys.
If yes, it will return the value of the @param argumentName from the request keys.
If not, it will return back the value which was passed in.
Note:This happens when there are validation error for instance.

Returns the update WebEvent used to update the Preferences value.

This method is called to generate all javascript functions related to this transform.

Renders the text of a Preference.

Renders a note for a Preference.

Renders the text of a Preference. This method associate the text label to its corresponding radiobox or checkbox.

Renders the text of a Preference.

Renders the text of a Preference.

Renders the text of a Preference. If the preference value is marked as invalid, then the text is highlighted.

Renders the title of a Preference.

Renders the title of a Preference.

Abstract method that must be override by the concrete class. This is called to generate the main body of the Preference dialog

Generates the footer of the Preferences dialog

Generates the Header of the Preferences dialog