org.zimowski.bambi.editor.config

Interface ConfigParameters

All Known Implementing Classes:

ConfigLoader

public interface ConfigParameters

List of valid parameters bambi can be configured with. Each parameter is a key in the property (configuration) file.

Author:

Adam Zimwoski

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTH_LOGINID_PLUGIN Determines how to secure user's login id before transmission.
static String	AUTH_PASS_PLUGIN Determines how to secure user's password id before transmission.
static String	AUTH_PROMPT Short sentence that will be displayed in the dialog prompting user to enter login credentials.
static String	AUTH_REQUIRED true if authentication is required before image upload; false if not required.
static String	AUTOLOAD_IMAGE_FILEPATH Path to image file if autoload is desired.
static String	BUSINESS_NAME_LONG Full name of your business organization as it relates to the website to which bambi is uploading.
static String	BUSINESS_NAME_SHORT Short name of your business organization as it relates to the website to which bambi is uploading.
static String	DEFAULT_AUTH_PROMPT
static String	HELP_PAGE_URL
static String	HOST
static String	IMAGE_EXPORT_PLUGIN Fully qualified class path to the plugin that will perform image export.
static String	LOOK_AND_FEEL Fully qualified class name to the look and feel UI class this applet should use.
static String	NUMBER_OF_PIC_OUTPUTS Number of picture output types radio buttons to display.
static String	PIC_OUTPUT_FORMAT Image format for the final output.
static String	PIC_POST_PROCESS_URL Deprecated. used to be handy from applet context; though app has outgrown the applet technology and is no longer targetted for applet deploy. Instead, Java Web Start should be used, which renders applet context related features obsolete. Instead of calling applet host page to notify pic refresh is needed, server should handle this task instead by employing javascript timeout (window.setInterval), or other server push simulation effect. This parameter is deprecated with no direct replacement. Setting it has no effect.
static String	PIC_PREFIX Picture parameter prefix.
static String	PIC_RADIO_LABEL Text to appear next to a radio button representing this picture.
static String	PIC_RATIO_PRESERVED Determines if resizing selector will preserve target dimension ratio.
static String	PIC_SELECTOR_FACTOR Controlling factor for the size of the selector used to chose sub image.
static String	PIC_SELECTOR_VISIBLE true if selector should be displayed on startup; false if it should be hidden on startup.
static String	PIC_TARGET_HEIGHT Height in pixes of the final generated size, after scaling.
static String	PIC_TARGET_SHAPE Final shape.
static String	PIC_TARGET_WIDTH Width in pixes of the final generated size, after scaling.
static String	RADIOGROUP_OUTPUTTYPE_LABEL Label which describes radio buttons for selecing picture output type.
static String	RULER_TOGGLE_ONOFF_VISIBLE controls if button which turns ruler visibility on/off is displayed or not.
static String	RULER_VISIBLE true if ruler should be shown; false if it should be hidden.
static String	WELCOME_RESOURCE_PATH Local resource path to file application should display on startup.
static String	WELCOME_URL URL to welcome file that will be displayed upon application startup inside the WelcomePanel.
static String	WINDOW_HEIGHT Preferred main window height.
static String	WINDOW_TITLE Alternative app name if in applet mode.
static String	WINDOW_WIDTH Preferred main widow width.

Field Detail

LOOK_AND_FEEL

static final String LOOK_AND_FEEL

Fully qualified class name to the look and feel UI class this applet should use. Optional. If not provided, default Java look and feel is used.

See Also:

Constant Field Values

WELCOME_URL

static final String WELCOME_URL

URL to welcome file that will be displayed upon application startup inside the WelcomePanel. If not provided or invalid, application will attempt to display WELCOME_RESOURCE_PATH instead.

See Also:

Constant Field Values

WELCOME_RESOURCE_PATH

static final String WELCOME_RESOURCE_PATH

Local resource path to file application should display on startup. This setting is ignored if WELCOME_URL is provided and correct. If this value is not provided or is incorrect, WelcomePanel is displayed empty.

See Also:

Constant Field Values

RULER_VISIBLE

static final String RULER_VISIBLE

true if ruler should be shown; false if it should be hidden. Default value is true.

See Also:

Constant Field Values

RULER_TOGGLE_ONOFF_VISIBLE

static final String RULER_TOGGLE_ONOFF_VISIBLE

controls if button which turns ruler visibility on/off is displayed or not. this button allows the user to show/hide the ruler. true if button should be shown; false if hidden. If shown, it uses #SHOW_RULER as default value. If not defined, button is shown.

See Also:

Constant Field Values

WINDOW_WIDTH

static final String WINDOW_WIDTH

Preferred main widow width. Optional. Default width is 800. Minimum value 640.

See Also:

Constant Field Values

WINDOW_HEIGHT

static final String WINDOW_HEIGHT

Preferred main window height. Optional. Default height is 600. Minimum value 480.

See Also:

Constant Field Values

NUMBER_OF_PIC_OUTPUTS

static final String NUMBER_OF_PIC_OUTPUTS

Number of picture output types radio buttons to display. Allowed values are 1, 2, 3 or 4. If 1 is defined, a single selected radio button shows up and it is disabled.

See Also:

Constant Field Values

IMAGE_EXPORT_PLUGIN

static final String IMAGE_EXPORT_PLUGIN

Fully qualified class path to the plugin that will perform image export. The default is MultipartFormPostImageUploader.

See Also:

FtpImageUploader, MultipartFormPostImageUploader, Constant Field Values

AUTH_REQUIRED

static final String AUTH_REQUIRED

true if authentication is required before image upload; false if not required. If authentication is required, user will be prompted for login id and password. Default is true.

See Also:

Constant Field Values

AUTH_PROMPT

static final String AUTH_PROMPT

Short sentence that will be displayed in the dialog prompting user to enter login credentials. The default is DEFAULT_AUTH_PROMPT.

See Also:

Constant Field Values

DEFAULT_AUTH_PROMPT

static final String DEFAULT_AUTH_PROMPT

See Also:

Constant Field Values

AUTH_LOGINID_PLUGIN

static final String AUTH_LOGINID_PLUGIN

Determines how to secure user's login id before transmission. The value is a fully qualified class name of the encryption plugin that implements TextEncrypter. The default value ClearTextProxy.

See Also:

ClearTextProxy, MD5Digest, RsaCipher, SHA1Digest, SHA256Digest, Constant Field Values

AUTH_PASS_PLUGIN

static final String AUTH_PASS_PLUGIN

Determines how to secure user's password id before transmission. The value is a fully qualified class name of the encryption plugin that implements TextEncrypter. The default value ClearTextProxy.

See Also:

ClearTextProxy, MD5Digest, RsaCipher, SHA1Digest, SHA256Digest, Constant Field Values

PIC_PREFIX

static final String PIC_PREFIX

Picture parameter prefix. To be followed by a number indicating position within the array. Not zero based, first picture denoted by 1. Not a valid parameter by itself, but to be used with all PIC_* parameters.

See Also:

Constant Field Values

PIC_TARGET_SHAPE

static final String PIC_TARGET_SHAPE

Final shape. Valid values are:

• Configuration.TARGET_SHAPE_RECT - SQUARE / RECTANGLE
• Configuration.TARGET_SHAPE_ELIPSE - ELIPSE / CIRCLE
• Configuration.TARGET_SHAPE_FULL - FULL PIC SIZE

Width and height parameters control squarness and eliptical factors. If width and height are the same, we get either square of circle, if they're different we get either rectangle of elipse. Requires picture prefix identifier to assemble full parameter name.

See Also:

Constant Field Values

PIC_RATIO_PRESERVED

static final String PIC_RATIO_PRESERVED

Determines if resizing selector will preserve target dimension ratio. By default (false) ratio is not preserved, but setting this to true will ensure that PIC_TARGET_HEIGHT and PIC_TARGET_WIDTH are resized relative one to another. This setting is ignored if PIC_TARGET_SHAPE is Configuration.TARGET_SHAPE_FULL.

See Also:

Constant Field Values

PIC_TARGET_WIDTH

static final String PIC_TARGET_WIDTH

Width in pixes of the final generated size, after scaling. Requires picture prefix identifier to assemble full parameter name. This setting is ignored if PIC_TARGET_SHAPE is Configuration.TARGET_SHAPE_FULL or if PIC_RATIO_PRESERVED is false.

See Also:

Constant Field Values

PIC_TARGET_HEIGHT

static final String PIC_TARGET_HEIGHT

Height in pixes of the final generated size, after scaling. Requires picture prefix identifier to assemble full parameter name. This setting is ignored if PIC_TARGET_SHAPE is Configuration.TARGET_SHAPE_FULL or if PIC_RATIO_PRESERVED is false.

See Also:

Constant Field Values

PIC_SELECTOR_VISIBLE

static final String PIC_SELECTOR_VISIBLE

true if selector should be displayed on startup; false if it should be hidden on startup. true if not defined

See Also:

Constant Field Values

PIC_SELECTOR_FACTOR

static final String PIC_SELECTOR_FACTOR

Controlling factor for the size of the selector used to chose sub image. Recommended value is 1.0 which means that selector will be drawn in the authentic size of the image's target dimensions (@see PIC_TARGET_WIDTH, PIC_TARGET_HEIGHT). This value can be reduced to draw a proportionally smaller selector, or increased to draw a larger selector. For example, a value of 0.5 would draw a selector half the original size. Selector cannot be defined in pixel size, as it has to be proportionally consistent with targetted output size. This parameter may be deprecated in the future because drawing selector at reduced size caused clipped image be upscaled to target dimensions. It is also a rather confusing parameter without much added benefit from usage perspective. It is highly recommended to not use this parameter and let the system draw it at a default factor size of 1f. Requires picture prefix identifier to assemble full parameter name.

See Also:

Constant Field Values

PIC_RADIO_LABEL

static final String PIC_RADIO_LABEL

Text to appear next to a radio button representing this picture. Requires picture prefix identifier to assemble full parameter name.

See Also:

Constant Field Values

PIC_OUTPUT_FORMAT

static final String PIC_OUTPUT_FORMAT

Image format for the final output. Only valid formats are JPEG and PNG. Requires picture prefix identifier to assemble full parameter name.

See Also:

ImageOutputFormat, Constant Field Values

PIC_POST_PROCESS_URL

static final String PIC_POST_PROCESS_URL

Deprecated. used to be handy from applet context; though app has outgrown the applet technology and is no longer targetted for applet deploy. Instead, Java Web Start should be used, which renders applet context related features obsolete. Instead of calling applet host page to notify pic refresh is needed, server should handle this task instead by employing javascript timeout (window.setInterval), or other server push simulation effect. This parameter is deprecated with no direct replacement. Setting it has no effect.

URL that will perform image upload post processing. This often is a javascript call to the browser to refresh uploaded image.

See Also:

Constant Field Values

HELP_PAGE_URL

static final String HELP_PAGE_URL

See Also:

Constant Field Values

HOST

static final String HOST

See Also:

Constant Field Values

BUSINESS_NAME_LONG

static final String BUSINESS_NAME_LONG

Full name of your business organization as it relates to the website to which bambi is uploading. This value may appear on various screens of the editor to better integrate your organization with bambi and end user's experience.

See Also:

Constant Field Values

BUSINESS_NAME_SHORT

static final String BUSINESS_NAME_SHORT

Short name of your business organization as it relates to the website to which bambi is uploading. Ideally this should be one word or simply top level domain of your website (Google or google.com, etc). This value may appear on various screens of the editor to better integrate your organization with bambi and end user's experience.

See Also:

Constant Field Values

WINDOW_TITLE

static final String WINDOW_TITLE

Alternative app name if in applet mode. This parameter is handy to better integrate bambi as an applet into a hosting website. This parameter is ignored in stand alone mode.

See Also:

Constant Field Values

RADIOGROUP_OUTPUTTYPE_LABEL

static final String RADIOGROUP_OUTPUTTYPE_LABEL

Label which describes radio buttons for selecing picture output type.

See Also:

Constant Field Values

AUTOLOAD_IMAGE_FILEPATH

static final String AUTOLOAD_IMAGE_FILEPATH

Path to image file if autoload is desired. Also handy when developing and/or testing. If set, init routine will immediately load the file into editor for display. In applet mode, applet file select will be bypassed.

See Also:

Constant Field Values