com.canto.cumulus.prefs

Class CropTemplate

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.CropTemplate

All Implemented Interfaces:

Item

public class CropTemplate
extends BaseManager
implements Item

This class manages all the settings of a single crop template.

Since:

11.0.2

See Also:

CropTemplatesList.getCropTemplate(String)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CropTemplate.Constraint The cropping constraints.
static class	CropTemplate.OutputSizeMode The cropping output size mode.
static class	CropTemplate.Type The type of crop template.

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

TYPE_EJP, TYPE_NATIVE

Method Summary

Methods

Modifier and Type	Method and Description
JPack	exportSet() Exports this set into a JPack.
CropTemplate.Constraint	getConstraint() Returns the crop constraint of this crop template.
java.awt.Dimension	getCropAspectRatio() Returns the aspect ratio constraint values for this crop template
java.awt.Dimension	getCropFixedSize() Returns the fixed size constraint value for this crop template
java.lang.String	getDescription(int languageID) Returns the description for the given language id.
java.lang.String	getDisplayName(int languageID, boolean fallbackToDefaultName) Returns the display name for the given language id.
java.lang.String	getGroupName() Returns the name of the group this template belongs to
java.lang.String	getID() Returns the UID of the item in the items namespace.
boolean	getIsDefault() Returns whether this crop template is the default crop template.
java.lang.String	getName() Returns the name of this crop template.
int	getOrientation() Returns the orientation of the focus area for this crop template (only for template of type Type#TYPE_FOCUS_AREA)
java.awt.Dimension	getOutputFixedSize() Returns the fixed output size value for this crop template
CropTemplate.OutputSizeMode	getOutputSizeMode() Returns the output size mode of this crop template.
RestrictionsList	getRestrictionsList() Returns the list of roles and users that are allowed to view this set.
CropTemplate.Type	getType() Returns the type of this crop template.
boolean	isAllowMultiple() Returns whether this template can have multiple value items
boolean	isDefault() Returns whether this item is the default item.
boolean	isMaster() Returns whether this template is a master in its group
boolean	isSharingRestricted() Returns whether the set visibility is restricted to a group of users or roles.
void	setAllowMultiple(boolean allowMultiple) Sets whether this crop template can be repeated (have multiple value items).
void	setConstraint(CropTemplate.Constraint constraint) Sets the constraint of this crop template
void	setCropAspectRatio(java.awt.Dimension aspectRatio) Sets the aspect ratio constraint values for this crop template.
void	setCropFixedSize(java.awt.Dimension fixedSize) Sets the fixed size constraint value for this crop template.
void	setDescription(int languageID, java.lang.String description) Sets the description for the given language.
void	setDisplayName(int languageID, java.lang.String displayName) Sets the display name for the given language.
void	setGroupName(java.lang.String groupName) Sets the fixed output size value for this crop template.
void	setIsMaster(boolean isMaster) Sets whether this crop template is a master in its group.
void	setOrientation(int orientation) Sets the fixed output size value for this crop template.
void	setOutputFixedSize(java.awt.Dimension fixedSize) Sets the fixed output size value for this crop template.
void	setOutputSizeMode(CropTemplate.OutputSizeMode outputSizeMode) Sets the output size mode of this crop template
void	setSharingRestricted(boolean value) Sets whether the set visibility is restricted to a group of users or roles.
void	setType(CropTemplate.Type type) Sets the type of this crop template

Methods inherited from class com.canto.cumulus.prefs.BaseManager

addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getName

public java.lang.String getName()

Returns the name of this crop template.

Returns:

name of this crop template

getID

public java.lang.String getID()

Description copied from interface: Item

Returns the UID of the item in the items namespace.

Specified by:

getID in interface Item

Returns:

item UID

isDefault

public boolean isDefault()

Description copied from interface: Item

Returns whether this item is the default item.

Specified by:

isDefault in interface Item

Returns:

true if this is the default item

getIsDefault

public boolean getIsDefault()

Returns whether this crop template is the default crop template.

Returns:

true if this is the default crop template

getType

public CropTemplate.Type getType()

Returns the type of this crop template.

Returns:

Either CropTemplate.Type.TYPE_MANUAL or CropTemplate.Type.TYPE_FOCUS_AREA

setType

public void setType(CropTemplate.Type type)

Sets the type of this crop template

Parameters:

type - either CropTemplate.Type.TYPE_MANUAL or CropTemplate.Type.TYPE_FOCUS_AREA

getConstraint

public CropTemplate.Constraint getConstraint()

Returns the crop constraint of this crop template.

Returns:

Either CropTemplate.Constraint.ASPECT_RATIO, CropTemplate.Constraint.FIXED_SIZE, or CropTemplate.Constraint.CUSTOM

setConstraint

public void setConstraint(CropTemplate.Constraint constraint)

Sets the constraint of this crop template

Parameters:

constraint - either CropTemplate.Constraint.ASPECT_RATIO, CropTemplate.Constraint.FIXED_SIZE, or CropTemplate.Constraint.CUSTOM

getCropAspectRatio

public java.awt.Dimension getCropAspectRatio()

Returns the aspect ratio constraint values for this crop template

Returns:

The aspect ratio as a Dimension where Dimension.width is the horizontal and Dimension.height is the vertical factor of the aspect ratio

setCropAspectRatio

public void setCropAspectRatio(java.awt.Dimension aspectRatio)

Sets the aspect ratio constraint values for this crop template. The aspect ratio is given as a Dimension where Dimension.width is the horizontal and Dimension.height is the vertical factor of the aspect ratio

getCropFixedSize

public java.awt.Dimension getCropFixedSize()

Returns the fixed size constraint value for this crop template

Returns:

The fixed size constraint value as a Dimension

setCropFixedSize

public void setCropFixedSize(java.awt.Dimension fixedSize)

Sets the fixed size constraint value for this crop template.

getOutputSizeMode

public CropTemplate.OutputSizeMode getOutputSizeMode()

Returns the output size mode of this crop template.

Returns:

Either CropTemplate.OutputSizeMode.AS_CROPPED, CropTemplate.OutputSizeMode.FIXED_SIZE, or CropTemplate.OutputSizeMode.CUSTOM

setOutputSizeMode

public void setOutputSizeMode(CropTemplate.OutputSizeMode outputSizeMode)

Sets the output size mode of this crop template

Parameters:

outputSizeMode - either CropTemplate.OutputSizeMode.AS_CROPPED, CropTemplate.OutputSizeMode.FIXED_SIZE, or CropTemplate.OutputSizeMode.CUSTOM

getOutputFixedSize

public java.awt.Dimension getOutputFixedSize()

Returns the fixed output size value for this crop template

Returns:

The fixed output size value as a Dimension

setOutputFixedSize

public void setOutputFixedSize(java.awt.Dimension fixedSize)

Sets the fixed output size value for this crop template.

Parameters:

fixedSize - the new fixed output size

getOrientation

public int getOrientation()

Returns the orientation of the focus area for this crop template (only for template of type Type#TYPE_FOCUS_AREA)

Returns:

The orientation of the focus area (0: any orientation, 1: top-left, 2: top-center, 3: top-right, 4: left-center, 5: center, 6: right-center, 7: bottom-left, 8: bottom-center, 9: bottom-right

setOrientation

public void setOrientation(int orientation)

Sets the fixed output size value for this crop template.

Parameters:

orientation - the new orientation

getGroupName

public java.lang.String getGroupName()

Returns the name of the group this template belongs to

Returns:

The crop template group name

setGroupName

public void setGroupName(java.lang.String groupName)

Sets the fixed output size value for this crop template.

Parameters:

groupName - the group name

isMaster

public boolean isMaster()

Returns whether this template is a master in its group

Returns:

The indication that this template is a master

setIsMaster

public void setIsMaster(boolean isMaster)

Sets whether this crop template is a master in its group.

Parameters:

isMaster - the master indicator

isAllowMultiple

public boolean isAllowMultiple()

Returns whether this template can have multiple value items

Returns:

The indication that this template can be repeated

setAllowMultiple

public void setAllowMultiple(boolean allowMultiple)

Sets whether this crop template can be repeated (have multiple value items).

Parameters:

allowMultiple - the multiple indicator

getDescription

public java.lang.String getDescription(int languageID)

Returns the description for the given language id.

Specified by:

getDescription in interface Item

Parameters:

languageID - specifying the language for the description

Returns:

description text

setDescription

public void setDescription(int languageID,
                  java.lang.String description)

Sets the description for the given language.

Specified by:

setDescription in interface Item

Parameters:

languageID - the language to set the description for

description - the new description

getDisplayName

public java.lang.String getDisplayName(int languageID,
                              boolean fallbackToDefaultName)

Returns the display name for the given language id.

Specified by:

getDisplayName in interface Item

Parameters:

languageID - specifying the language for the display name

fallbackToDefaultName - when set to true this method returns the default name when now localized display name is available otherwise null

Returns:

display name

setDisplayName

public void setDisplayName(int languageID,
                  java.lang.String displayName)

Sets the display name for the given language.

Specified by:

setDisplayName in interface Item

Parameters:

languageID - the language to set the display name for

displayName - the new display name

exportSet

public JPack exportSet()

Exports this set into a JPack.

Specified by:

exportSet in interface Item

Returns:

exported data as JPack

See Also:

CropTemplatesList.importSet(JPack, SetImportDuplicatesMode)

isSharingRestricted

public boolean isSharingRestricted()

Returns whether the set visibility is restricted to a group of users or roles.

Specified by:

isSharingRestricted in interface Item

Returns:

true if the set visibility is restricted to a group of users or roles

setSharingRestricted

public void setSharingRestricted(boolean value)

Sets whether the set visibility is restricted to a group of users or roles.

Specified by:

setSharingRestricted in interface Item

Parameters:

value - set to true if the set visibility should be restricted to a group of users or roles

getRestrictionsList

public RestrictionsList getRestrictionsList()

Returns the list of roles and users that are allowed to view this set. Only applicable for shared set and if isSharingRestricted() returns true.

Specified by:

getRestrictionsList in interface Item

Returns:

list of roles and users that are allowed to view this set