org.zimowski.bambi.editor.config

Interface Configuration

public interface Configuration

Application global settings configurable externally. These are typically stored in the configuration (properties) file.

Author:

Adam Zimowski (mrazjava)

Field Summary

Fields

Modifier and Type	Field and Description
static String	APP_NAME application name
static String	RESOURCE_PATH
static int	TARGET_SHAPE_ELIPSE Picture section selector will be in oval shape
static int	TARGET_SHAPE_FULL Picture section selector will match the size of the photo, with scaling taken into account
static int	TARGET_SHAPE_RECT Picture section selector will be in rectangular shape

Method Summary

Methods

Modifier and Type	Method and Description
AppletContext	getAppletContext() Deprecated. No direct replacement. This app has outgrown the applet technology. Use Java Web Start instead.
String	getAuthenticationPrompt()
File	getAutoloadImageFile() Returns image file to be loaded on startup, if one is configured and read successfully.
String	getBusinessNameLong() Name of the business running this app.
String	getBusinessNameShort() One word short name of the business.
String	getHelpPageUrl() Full URL to the home page of the help system.
ImageExporter	getImageExporter() Returns image export plugin.
Properties	getImageExporterConfig()
TextEncrypter	getLoginIdEncrypter()
Properties	getLoginIdEncrypterConfig()
String	getLookAndFeel()
int	getNumberOfPics()
TextEncrypter	getPasswordEncrypter()
Properties	getPasswordEncrypterConfig()
ImageOutputSettings	getPicSettings(int picNo)
String	getRadioOutputTypeLabel() Desired label for selector radio button group.
String	getRemoteHost() URL of a remote host where image should be uploaded to.
String	getWelcomeResourcePath() Internal resource for welcome startup screen.
String	getWelcomeUrl() External URL for welcome startup screen.
int	getWindowHeight()
String	getWindowTitle()
int	getWindowWidth()
boolean	isAuthenticationRequired() Determines if user must authenticate to the server before uploading a photo.
boolean	isRulerToggleVisible()
boolean	isRulerVisible() Determines if ruler is enabled for this instance.
boolean	isSelectorVisible()

Field Detail

RESOURCE_PATH

static final String RESOURCE_PATH

See Also:

Constant Field Values

TARGET_SHAPE_RECT

static final int TARGET_SHAPE_RECT

Picture section selector will be in rectangular shape

See Also:

Constant Field Values

TARGET_SHAPE_ELIPSE

static final int TARGET_SHAPE_ELIPSE

Picture section selector will be in oval shape

See Also:

Constant Field Values

TARGET_SHAPE_FULL

static final int TARGET_SHAPE_FULL

Picture section selector will match the size of the photo, with scaling taken into account

See Also:

Constant Field Values

APP_NAME

static final String APP_NAME

application name

See Also:

Constant Field Values

Method Detail

getNumberOfPics

int getNumberOfPics()

Returns:

See Also:

ConfigParameters.NUMBER_OF_PIC_OUTPUTS

isSelectorVisible

boolean isSelectorVisible()

Returns:

See Also:

ConfigParameters.PIC_SELECTOR_VISIBLE

isRulerVisible

boolean isRulerVisible()

Determines if ruler is enabled for this instance. Method name may be misleading indicating initial visibility, however, it set to false the ruler will be hidden for the entier application's lifecycle.

Returns:

true if ruler should be visible; false if hidden

See Also:

ConfigParameters.RULER_VISIBLE

isRulerToggleVisible

boolean isRulerToggleVisible()

Returns:

See Also:

ConfigParameters.RULER_TOGGLE_ONOFF_VISIBLE

getWindowWidth

int getWindowWidth()

Returns:

See Also:

ConfigParameters.WINDOW_WIDTH

getWindowHeight

int getWindowHeight()

Returns:

See Also:

ConfigParameters.WINDOW_HEIGHT

getPicSettings

ImageOutputSettings getPicSettings(int picNo)
                                   throws ArrayIndexOutOfBoundsException

Throws:

ArrayIndexOutOfBoundsException

getHelpPageUrl

String getHelpPageUrl()

Full URL to the home page of the help system.

Returns:

See Also:

ConfigParameters.HELP_PAGE_URL

getRemoteHost

String getRemoteHost()

URL of a remote host where image should be uploaded to.

Returns:

See Also:

ConfigParameters.HOST

getBusinessNameLong

String getBusinessNameLong()

Name of the business running this app. Obviously optional, but if provided it may appear on the GUI in places such as about box.

Returns:

See Also:

ConfigParameters.BUSINESS_NAME_LONG

getBusinessNameShort

String getBusinessNameShort()

One word short name of the business. This could be short top level domain as well. Used in certain screens such as login prompt to better integrate end user experience with your organization.

Returns:

See Also:

ConfigParameters.BUSINESS_NAME_SHORT

getAutoloadImageFile

File getAutoloadImageFile()

Returns image file to be loaded on startup, if one is configured and read successfully. Null at all other times. Optional configuration, typically used for testing and debugging as user is expected to manually select (open) their own file.

Returns:

file to display in editor on startup; null if none

See Also:

ConfigParameters.AUTOLOAD_IMAGE_FILEPATH

getWindowTitle

String getWindowTitle()

Returns:

See Also:

ConfigParameters.WINDOW_TITLE

getLookAndFeel

String getLookAndFeel()

Returns:

See Also:

ConfigParameters.LOOK_AND_FEEL

getImageExporter

ImageExporter getImageExporter()

Returns image export plugin. If not explicitly defined, default one is used.

Returns:

the plugin to handle image upload process

See Also:

ConfigParameters.IMAGE_EXPORT_PLUGIN

getImageExporterConfig

Properties getImageExporterConfig()

Returns:

plugin specific configuration for image export

isAuthenticationRequired

boolean isAuthenticationRequired()

Determines if user must authenticate to the server before uploading a photo.

Returns:

true if upload athentication is required; false otherwise

See Also:

ConfigParameters.AUTH_REQUIRED

getLoginIdEncrypter

TextEncrypter getLoginIdEncrypter()

Returns:

algorithm to use for securing login id before transmitting to the server

See Also:

ConfigParameters.AUTH_LOGINID_PLUGIN

getLoginIdEncrypterConfig

Properties getLoginIdEncrypterConfig()

Returns:

optional configuration for encrypter plugin

getPasswordEncrypter

TextEncrypter getPasswordEncrypter()

Returns:

algorithm to use for securing the password before transmitting to the server

See Also:

ConfigParameters.AUTH_PASS_PLUGIN

getPasswordEncrypterConfig

Properties getPasswordEncrypterConfig()

Returns:

optional configuration for encrypter plugin

getAuthenticationPrompt

String getAuthenticationPrompt()

Returns:

custom prompt displayed when authenticating a user

See Also:

ConfigParameters.AUTH_PROMPT

getAppletContext

AppletContext getAppletContext()

Deprecated. No direct replacement. This app has outgrown the applet technology. Use Java Web Start instead.

Returns:

context of this applet; null if stand alone app

getRadioOutputTypeLabel

String getRadioOutputTypeLabel()

Desired label for selector radio button group. This label describes the nature of these buttons. For example, if the radio buttons action changes selector to a different shape, this label may be called "Selector", however it is up to the implementation to provide the default in absence of a setting for this configuration.

Returns:

See Also:

ConfigParameters.RADIOGROUP_OUTPUTTYPE_LABEL

getWelcomeUrl

String getWelcomeUrl()

External URL for welcome startup screen. Optional. Superseeds getWelcomeResourcePath().

Returns:

See Also:

ConfigParameters.WELCOME_URL

getWelcomeResourcePath

String getWelcomeResourcePath()

Internal resource for welcome startup screen. Optional. Superseeded by getWelcomeUrl().

Returns:

See Also:

ConfigParameters.WELCOME_RESOURCE_PATH