de.espirit.firstspirit.access.project

Interface Resolution

public interface Resolution

Picture resolution

Since:

2.3

See Also:

Project.getResolutions()

Field Summary

Fields

Modifier and Type	Field and Description
static String	ORIGINAL_RESOLUTION_NAME
static String	PREVIEW_RES_NAME

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Get the technical description of this resolution
String	getDescription(Language language) Get the editorial description of this resolution for the given language or null if not defined for the language
String	getDisplayName(Language language) Gets display name of the resolution for the given language.
int	getHeight() Gets the height of the resolution
boolean	getKeepAspectRatio() Returns true if aspect ratio of the original resolution should be kept, false otherwise (default)
String	getName() Deprecated. since 4.2.12 use getUid() instead
String	getUid() Returns the unique identifier of this resolution.
int	getWidth() Gets the width of the resolution
boolean	isOriginal() Returns true if this resolution is the original resolution
void	setDescription(Language language, String description) Sets the editorial description of the resolution for the given language
void	setDescription(String description) Sets the technical description of the resolution
void	setDisplayName(Language language, String displayName) Sets the display name of the resolution for the given language
void	setHeight(int height) Sets the height of the resolution
void	setKeepAspectRatio(boolean value) Provide true if aspect ratio of the original resolution should be kept, false otherwise (default)
void	setName(String uid) Deprecated. since 4.2.12 - no replacement
void	setUid(String uid) Deprecated. since 5.0.18 - remove resolution from project and create new instance instead.
void	setWidth(int width) Sets the width of the resolution

Field Detail

ORIGINAL_RESOLUTION_NAME

static final String ORIGINAL_RESOLUTION_NAME

Since:

4.0.19

See Also:

Constant Field Values

PREVIEW_RES_NAME

static final String PREVIEW_RES_NAME

Since:

4.0.19

See Also:

Constant Field Values

Method Detail

getName

@Deprecated
String getName()

Deprecated. since 4.2.12 use getUid() instead

Calls getUid().

Returns:

The uid string.

Since:

2.3

getUid

String getUid()

Returns the unique identifier of this resolution.

Returns:

the uid of the resolution

Since:

4.2.12

See Also:

setUid(String)

getDisplayName

@Nullable
String getDisplayName(Language language)

Gets display name of the resolution for the given language.

Parameters:

language - Language for which the display name is requested.

Returns:

the display name or null if not defined

Since:

4.2.10

setName

@Deprecated
void setName(String uid)

Deprecated. since 4.2.12 - no replacement

Do not change uid of resolution. Delete resolution and create new instance instead.

Parameters:

uid - new uid

Since:

2.3

setUid

@Deprecated
void setUid(String uid)

Deprecated. since 5.0.18 - remove resolution from project and create new instance instead.

Do not change uid of resolution. Remove resolution from project and create new instance instead.

Parameters:

uid - new uid

Since:

4.2.12

See Also:

getUid()

setDisplayName

void setDisplayName(Language language,
                  String displayName)

Sets the display name of the resolution for the given language

Parameters:

displayName - the new displayname

language - the language to set the display name for

Since:

4.2.10

getDescription

String getDescription()

Get the technical description of this resolution

Returns:

the technical description

Since:

2.3

getDescription

@Nullable
String getDescription(Language language)

Get the editorial description of this resolution for the given language or null if not defined for the language

Parameters:

language - the language to get the description for

Returns:

the description for the given language if defined, null otherwise

Since:

4.2.10

setDescription

void setDescription(String description)

Sets the technical description of the resolution

Parameters:

description - the new description

Since:

2.3

setDescription

void setDescription(Language language,
                  String description)

Sets the editorial description of the resolution for the given language

Parameters:

description - the new description

language - the language to set the description for

Since:

4.2.10

getHeight

int getHeight()

Gets the height of the resolution

Returns:

the height value

Since:

2.3

setHeight

void setHeight(int height)

Sets the height of the resolution

Parameters:

height - the new height value

Since:

2.3

getWidth

int getWidth()

Gets the width of the resolution

Returns:

the width value

Since:

2.3

setWidth

void setWidth(int width)

Sets the width of the resolution

Parameters:

width - the new width value

Since:

2.3

isOriginal

boolean isOriginal()

Returns true if this resolution is the original resolution

Returns:

true if it is the original resolution, false otherwise

Since:

2.3

getKeepAspectRatio

boolean getKeepAspectRatio()

Returns true if aspect ratio of the original resolution should be kept, false otherwise (default)

Since:

4.0.90

setKeepAspectRatio

void setKeepAspectRatio(boolean value)

Provide true if aspect ratio of the original resolution should be kept, false otherwise (default)

Parameters:

value - if true the set width and height of this resolution is used as maximum side length

Since:

4.0.90