com.canto.cumulus.prefs

Class FormatListModuleEntry

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.FormatListModuleEntry

public class FormatListModuleEntry
extends BaseManager

This class manages a single format entry of an AssetFormatsList.

Nested Class Summary

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
void	clearStatus() Clears all status information.
java.lang.String	getFileFormatExtension() Returns the file format extension.
java.lang.String	getFileFormatIdentifier() Returns the file format identifier.
java.lang.String	getFileFormatMacFiletype() Returns the Mac filetype.
java.lang.String	getFileFormatName() Returns the file format display name.
int	getFileFormatType() Returns the file type as an enum id.
int	getFilterPosition() Returns the index of this format within the filter list of supported formats.
boolean	getFormatIsAvailable() Returns whether this format is currently available (is the filter installed).
boolean	getIsActive() Returns whether this format is active.
boolean	getSetupIsAvailable() Returns whether this format has a setup dialog.
java.lang.String	getUID() Returns the modules UID for this format.
void	setActive(boolean active) Configures whether this format is active.
void	setFileFormatType(int type) Sets the file type as an enum id.

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

getUID

public java.lang.String getUID()

Returns the modules UID for this format.

Returns:

module UID

getFileFormatName

public java.lang.String getFileFormatName()

Returns the file format display name.

Returns:

file format display name

getFileFormatExtension

public java.lang.String getFileFormatExtension()

Returns the file format extension.

Returns:

file format extension

getFileFormatMacFiletype

public java.lang.String getFileFormatMacFiletype()

Returns the Mac filetype.

Returns:

Mac filetype

getIsActive

public boolean getIsActive()

Returns whether this format is active.

Returns:

true if this format is active

setActive

public void setActive(boolean active)

Configures whether this format is active.

Parameters:

active - set to true if this format is active

getFilterPosition

public int getFilterPosition()

Returns the index of this format within the filter list of supported formats.

Returns:

index of this format within the filter list of supported formats

getFormatIsAvailable

public boolean getFormatIsAvailable()

Returns whether this format is currently available (is the filter installed).

Returns:

true if this format is currently available

getSetupIsAvailable

public boolean getSetupIsAvailable()

Returns whether this format has a setup dialog.

Returns:

true if this format has a setup dialog

getFileFormatIdentifier

public java.lang.String getFileFormatIdentifier()

Returns the file format identifier.

Returns:

file format identifier or null if not available

Since:

8.1.2

getFileFormatType

public int getFileFormatType()

Returns the file type as an enum id.

Returns:

file type as an enum id or -1 if not set

Since:

9.0

setFileFormatType

public void setFileFormatType(int type)

Sets the file type as an enum id.

Parameters:

type - file type as an enum id or -1 to clear

Since:

9.0

clearStatus

public void clearStatus()

Clears all status information.