Class CommonImageBackground

java.lang.Object

de.xima.fc.prompt.service.support.CommonImageBackground

public final class CommonImageBackground
extends Object

Enumeration for common types of image backgrounds. Certain task types such as "generate image" or "edit image" produce image files. Some prompt services allow the user to select the background of that image file. Implementations are encouraged to use these constants to increase interoperability between different prompt service implementations, but are not required to do so.

Since:

8.5.0

See Also:

• IPromptQueryConfig_ImageBackground

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OPAQUE	An opaque image background.
static final String	TRANSPARENT	A transparent image background.

Method Summary

Modifier and Type	Method	Description
static String	localizedDescription(Locale locale, String commonImageBackground)	Gets the localized description for the given common image background.
static String	localizedLabel(Locale locale, String commonImageBackground)	Gets the localized label for the given common image background.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

OPAQUE

public static final String OPAQUE

An opaque image background.

See Also:

• Constant Field Values

TRANSPARENT

public static final String TRANSPARENT

A transparent image background.

See Also:

• Constant Field Values

Method Details

localizedDescription

public static String localizedDescription(Locale locale,
 String commonImageBackground)

Gets the localized description for the given common image background. The value should be one of the constants defined in this class. When an unknown value is given, returns an implementation-defined default description.

Parameters:

locale - The locale for which to localize the description.

commonImageBackground - The common image background constant, must be one of the constants defined in this class.

Returns:

The localized description for the given common image background.

localizedLabel

public static String localizedLabel(Locale locale,
 String commonImageBackground)

Gets the localized label for the given common image background. The value should be one of the constants defined in this class. If any other value is given, returns an implementation-defined default label.

Parameters:

locale - The locale for which to localize the label.

commonImageBackground - The common image background constant, must be one of the constants defined in this class.

Returns:

The localized label for the given common image background.