Package wt.preference

Class PreferenceDefinition

java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.preference._AbstractPreference
wt.preference.AbstractPreference
wt.preference._PreferenceDefinition
wt.preference.PreferenceDefinition
All Implemented Interfaces:
com.ptc.windchill.bac._BACManaged, com.ptc.windchill.bac.BACManaged, Externalizable, Serializable, Comparable, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, NetFactor, ObjectMappable, Persistable, DisplayIdentification
@GenAsPersistable(superClass=AbstractPreference.class,properties={@GeneratedProperty(name="fullDescription",type=java.lang.String.class,javaDoc="This is the localized full description of the preference that the user will see in the GUI",constraints=@PropertyConstraints(upperLimit=4000)),@GeneratedProperty(name="visibility",type=java.lang.Integer.class,javaDoc="This indicates in which parts of the Preference Manager GUI the preference will be visible",constraints=@PropertyConstraints(required=true)),@GeneratedProperty(name="handler",type=java.lang.String.class,constraints=@PropertyConstraints(upperLimit=3000,required=true)),@GeneratedProperty(name="theHandler",type=PreferenceValueHandler.class,javaDoc="The handler for processing the preference values.",accessors=@PropertyAccessors(getAccess=PRIVATE),columnProperties=@ColumnProperties(persistent=false)),@GeneratedProperty(name="defaultValue",type=java.lang.String.class,javaDoc="The default value of the preference",constraints=@PropertyConstraints(upperLimit=4000)),@GeneratedProperty(name="clientOverridable",type=java.lang.Boolean.class),@GeneratedProperty(name="clientDelegate",type=java.lang.String.class,javaDoc="String representing the PreferenceClientDelegate class to be used to determine applicable clients for the preference."),@GeneratedProperty(name="clientData",type=java.lang.String.class,javaDoc="String containing the data used by the PreferenceClientDelegate class in determining applicable clients for the preference.",constraints=@PropertyConstraints(upperLimit=2000)),@GeneratedProperty(name="defaultComment",type=java.lang.String.class,javaDoc="The default comment of the preference",constraints=@PropertyConstraints(upperLimit=500))},dataType=ADMIN) public final class PreferenceDefinition extends wt.preference._PreferenceDefinition
The PreferenceDefinition is the object that contains all of the static information about a preference. This is the core object, it embodies what the preference "is".

Use the newPreferenceDefinition static factory method(s), not the PreferenceDefinition constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.



Supported API: true

Extendable: false

See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    VISIBILITY_HIDDEN
    Invisible to the GUI

    Supported API: true
    static final int
    VISIBILITY_ORG
    Visible in all Organization and the Site Utilities Preference Managers

    Supported API: true
    static final int
    VISIBILITY_SITE
    Only visible in the Site Utilities Preference Manager

    Supported API: true
    static final int
    VISIBILITY_USER
    Visible in all Home (User), all Container, all Organization and the Site Utilities Preference Managers

    Supported API: true
    static final int
    VISIBILITY_USER_ONLY
    Only visible in all Home (User) Utilities Preference Managers

    Supported API: true

    Fields inherited from class wt.preference._PreferenceDefinition

    CLIENT_DATA, CLIENT_DELEGATE, CLIENT_OVERRIDABLE, DEFAULT_COMMENT, DEFAULT_VALUE, EXTERNALIZATION_VERSION_UID, FULL_DESCRIPTION, HANDLER, VISIBILITY

    Fields inherited from class wt.preference._AbstractPreference

    DISPLAY_NAME, NAME, SHORT_DESCRIPTION

    Fields inherited from class wt.fc._WTObject

    CREATE_TIMESTAMP, MODIFY_TIMESTAMP

    Fields inherited from interface wt.fc._Persistable

    PERSIST_INFO

    Fields inherited from interface wt.identity.DisplayIdentification

    DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

    Fields inherited from interface wt.fc.Persistable

    IDENTITY, TYPE

  • Method Summary

    Methods inherited from class wt.preference._PreferenceDefinition

    getClassInfo, getClientData, getClientDelegate, getClientOverridable, getConceptualClassname, getDefaultComment, getDefaultValue, getFullDescription, getHandler, getType, getVisibility, readExternal, readExternal, readVersion, setClientData, setClientDelegate, setClientOverridable, setDefaultComment, setFullDescription, setVisibility, super_readExternal_PreferenceDefinition, super_readVersion_PreferenceDefinition, super_writeExternal_PreferenceDefinition, writeExternal, writeExternal

    Methods inherited from class wt.preference.AbstractPreference

    compareTo, getLocalizableMessage, getLocalizedName, getLocalizedShortDescription, isMatch, isMatch, resourceKey, resourceName

    Methods inherited from class wt.preference._AbstractPreference

    getDisplayName, getName, getShortDescription, readVersion, setDisplayName, setName, setShortDescription, super_readExternal_AbstractPreference, super_readVersion_AbstractPreference, super_writeExternal_AbstractPreference

    Methods inherited from class wt.fc.WTObject

    checkAttributes, duplicate, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, initialize, toString

    Methods inherited from class wt.fc._WTObject

    equals, getCreateTimestamp, getModifyTimestamp, getPersistInfo, hashCode, readVersion, setPersistInfo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • VISIBILITY_HIDDEN

      public static final int VISIBILITY_HIDDEN
      Invisible to the GUI

      Supported API: true
      See Also:

    • VISIBILITY_SITE

      public static final int VISIBILITY_SITE
      Only visible in the Site Utilities Preference Manager

      Supported API: true
      See Also:

    • VISIBILITY_ORG

      public static final int VISIBILITY_ORG
      Visible in all Organization and the Site Utilities Preference Managers

      Supported API: true
      See Also:

    • VISIBILITY_USER

      public static final int VISIBILITY_USER
      Visible in all Home (User), all Container, all Organization and the Site Utilities Preference Managers

      Supported API: true
      See Also:

    • VISIBILITY_USER_ONLY

      public static final int VISIBILITY_USER_ONLY
      Only visible in all Home (User) Utilities Preference Managers

      Supported API: true
      See Also: