com.actional.ui.plugin

Interface ISettingUIDescription

All Superinterfaces:

ISettingDescription

public interface ISettingUIDescription
extends ISettingDescription

Field Summary

Fields

Modifier and Type	Field and Description
static int	SIZE_LARGE
static int	SIZE_NORMAL
static int	SIZE_SMALL

Method Summary

Modifier and Type	Method and Description
ISettingUIDescription	setContentType(java.lang.String value) Sets the content type used when downloading the UI component's data.
ISettingUIDescription	setIsDownloadable(boolean value) Determines whether the object set through the UI component is available for download.
ISettingUIDescription	setIsMasked(boolean value) Sets the 'masked' flag for this UI component.
ISettingUIDescription	setLines(int value) Sets the number of lines for this UI component.
ISettingUIDescription	setUnit(java.lang.String value) Sets the unit for the data being entered through the UI component
ISettingUIDescription	setWidth(int value) Sets the width of the UI element.

Methods inherited from interface com.actional.plugin.ISettingDescription

setDefaultValue, setDescription, setIsEditable, setPossibleValues, setRequired

Field Detail

SIZE_SMALL

static final int SIZE_SMALL

See Also:

Constant Field Values

SIZE_NORMAL

static final int SIZE_NORMAL

See Also:

Constant Field Values

SIZE_LARGE

static final int SIZE_LARGE

See Also:

Constant Field Values

Method Detail

setIsMasked

ISettingUIDescription setIsMasked(boolean value)
                           throws java.lang.Exception

Sets the 'masked' flag for this UI component. If set to true, this will be used to mask the user input performed on this component.

Parameters:

value - true to force the UI component to mask its input, false otherwise (Default: false)

Returns:

The updated ISettingUIDescription

Throws:

java.lang.Exception

setLines

ISettingUIDescription setLines(int value)
                        throws java.lang.Exception

Sets the number of lines for this UI component. This setting only applies to certain components that prompt for user data, i.e. text fields.

Parameters:

value - number of lines of this UI component (Default: 1)

Returns:

The updated ISettingUIDescription

Throws:

java.lang.Exception

setWidth

ISettingUIDescription setWidth(int value)
                        throws java.lang.Exception

Sets the width of the UI element.

Parameters:

value - Either one of SIZE_SMALL, SIZE_NORMAL or SIZE_LARGE, or the actual value (in px) that should be applied to the UI component

Returns:

The updated ISettingUIDescription

Throws:

java.lang.Exception

setIsDownloadable

ISettingUIDescription setIsDownloadable(boolean value)
                                 throws java.lang.Exception

Determines whether the object set through the UI component is available for download. This option only applies to settings of type ISettingTypes.TYPE_FILE.

Parameters:

value - true to support downloading of UI component's payload, false otherwise

Returns:

The updated ISettingUIDescription

Throws:

java.lang.Exception

setContentType

ISettingUIDescription setContentType(java.lang.String value)
                              throws java.lang.Exception

Sets the content type used when downloading the UI component's data. This option only applies to settings of type ISettingTypes.TYPE_FILE that support downloading of the component's file contents.

Parameters:

value - true to support downloading of UI component's file data, false otherwise

Returns:

The updated ISettingUIDescription

Throws:

java.lang.Exception

setUnit

ISettingUIDescription setUnit(java.lang.String value)
                       throws java.lang.Exception

Sets the unit for the data being entered through the UI component

Parameters:

value - Name of unit to be displayed at an appropriate location for the UI component

Returns:

The updated ISettingUIDescription

Throws:

java.lang.Exception