etomica
Class EtomicaInfo

java.lang.Object
  etomica.EtomicaInfo

All Implemented Interfaces:

Serializable

public class EtomicaInfo
extends Object
implements Serializable

See Also:

Serialized Form

Field Summary

protected static int

MAX_SHORT_DESCRIPTION_LENGTH

Constructor Summary

EtomicaInfo()

EtomicaInfo(String desc)

EtomicaInfo(String desc, String short_desc)

Method Summary

String	getDescription()
FeatureSet	getFeatures()
static EtomicaInfo	getInfo(Class myclass)
String	getShortDescription() The need for a short text to put on pull down menus made it necessary to add this function.
boolean	isEnabled() Accessor for flag indicating if component is enabled for use in Etomica.
protected void	setDefaultFeatureSet()
void	setDescription(String str)
void	setEnabled(boolean b) Mutator for flag indicating if component is enabled for use in Etomica.
void	setShortDescription(String str)

Methods inherited from class java.lang.Object

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

Field Detail

MAX_SHORT_DESCRIPTION_LENGTH

protected static final int MAX_SHORT_DESCRIPTION_LENGTH

See Also:

Constant Field Values

Constructor Detail

EtomicaInfo

public EtomicaInfo()

EtomicaInfo

public EtomicaInfo(String desc)

EtomicaInfo

public EtomicaInfo(String desc,
                   String short_desc)

Method Detail

setDefaultFeatureSet

protected void setDefaultFeatureSet()

getFeatures

public FeatureSet getFeatures()

getInfo

public static EtomicaInfo getInfo(Class myclass)

getDescription

public String getDescription()

setDescription

public void setDescription(String str)

getShortDescription

public String getShortDescription()

The need for a short text to put on pull down menus made it necessary to add this function. By default it takes the description field (possibly long) and will return a substring of it, indicating continuation with with ellipsis (...)

Returns:

Short description of this field

setShortDescription

public void setShortDescription(String str)

isEnabled

public boolean isEnabled()

Accessor for flag indicating if component is enabled for use in Etomica. May be set to false if other required classes are absent (for example, 3D graphics libraries needed for display). Default is true.

setEnabled

public void setEnabled(boolean b)

Mutator for flag indicating if component is enabled for use in Etomica. May be set to false if other required classes are absent (for example, 3D graphics libraries needed for display). Default is true.