Interface IPropertyType


public interface IPropertyType
Base class for the meta-data for property types. Every property has a property type. The property type provides a display name, data validation methods, an XML name, and more.

Note that the property type information is a partial description of a property. Some types (such as choice) require further information specific to the property, such as the actual list of choices.

  • Field Details

    • STRING_TYPE

      static final int STRING_TYPE
      Type code for the String property type.
      See Also:
    • NUMBER_TYPE

      static final int NUMBER_TYPE
      Type code for the Number property type.
      See Also:
    • INTEGER_TYPE

      static final int INTEGER_TYPE
      Type code for the Integer property type.
      See Also:
    • DIMENSION_TYPE

      static final int DIMENSION_TYPE
      Type code for the Dimension property type.
      See Also:
    • COLOR_TYPE

      static final int COLOR_TYPE
      Type code for the Color property type.
      See Also:
    • CHOICE_TYPE

      static final int CHOICE_TYPE
      Type code for the Choice property type.
      See Also:
    • BOOLEAN_TYPE

      static final int BOOLEAN_TYPE
      Type code for the Boolean property type.
      See Also:
    • EXPRESSION_TYPE

      static final int EXPRESSION_TYPE
      Type code for the Expression property type.
      See Also:
    • HTML_TYPE

      static final int HTML_TYPE
      Type code for the HTML property type.
      See Also:
    • RESOURCE_KEY_TYPE

      static final int RESOURCE_KEY_TYPE
      Type code for the resource key property type.
      See Also:
    • URI_TYPE

      static final int URI_TYPE
      Type code for the URI property type.
      See Also:
    • DATE_TIME_TYPE

      static final int DATE_TIME_TYPE
      Type code for the Date time property type.
      See Also:
    • XML_TYPE

      static final int XML_TYPE
      Type code for the XML property type.
      See Also:
    • NAME_TYPE

      static final int NAME_TYPE
      Type code for the Name property type.
      See Also:
    • FLOAT_TYPE

      static final int FLOAT_TYPE
      Type code for the Float property type.
      See Also:
    • ELEMENT_REF_TYPE

      static final int ELEMENT_REF_TYPE
      Type code for the Element reference property type.
      See Also:
    • STRUCT_TYPE

      static final int STRUCT_TYPE
      Type code for the Structure property type.
      See Also:
    • EXTENDS_TYPE

      static final int EXTENDS_TYPE
      Type code for the Extends property type.
      See Also:
    • SCRIPT_TYPE

      static final int SCRIPT_TYPE
      Type code for the Script property type.
      See Also:
    • STRUCT_REF_TYPE

      static final int STRUCT_REF_TYPE
      Type code for the structure reference property type.
      See Also:
    • LIST_TYPE

      static final int LIST_TYPE
      Type code for the list property type.
      See Also:
    • LITERAL_STRING_TYPE

      static final int LITERAL_STRING_TYPE
      Type code for the Literal String property type.
      See Also:
    • MEMBER_KEY_TYPE

      static final int MEMBER_KEY_TYPE
      Type code for the key property type of a structure member.
      See Also:
    • ELEMENT_TYPE

      static final int ELEMENT_TYPE
      Type code for element property type.
      See Also:
    • CONTENT_ELEMENT_TYPE

      static final int CONTENT_ELEMENT_TYPE
      Type code for element attribute type. This is different from ELEMENT_TYPE. Its behavior like STRUCT_TYPE and isList=true.
      See Also:
    • LOCALE_TYPE

      static final int LOCALE_TYPE
      Type code for locale property type.
      See Also:
    • TYPE_COUNT

      static final int TYPE_COUNT
      Number of types defined.
      See Also:
    • STRING_TYPE_NAME

      static final String STRING_TYPE_NAME
      Name of the String property type.
      See Also:
    • NUMBER_TYPE_NAME

      static final String NUMBER_TYPE_NAME
      Name of the Number property type.
      See Also:
    • INTEGER_TYPE_NAME

      static final String INTEGER_TYPE_NAME
      Name of the Integer property type.
      See Also:
    • DIMENSION_TYPE_NAME

      static final String DIMENSION_TYPE_NAME
      Name of the Dimension property type.
      See Also:
    • COLOR_TYPE_NAME

      static final String COLOR_TYPE_NAME
      Name of the Color property type.
      See Also:
    • CHOICE_TYPE_NAME

      static final String CHOICE_TYPE_NAME
      Name of the Choice property type.
      See Also:
    • BOOLEAN_TYPE_NAME

      static final String BOOLEAN_TYPE_NAME
      Name of the Boolean property type.
      See Also:
    • EXPRESSION_TYPE_NAME

      static final String EXPRESSION_TYPE_NAME
      Name of the Expression property type.
      See Also:
    • HTML_TYPE_NAME

      static final String HTML_TYPE_NAME
      Name of the HTML property type.
      See Also:
    • RESOURCE_KEY_TYPE_NAME

      static final String RESOURCE_KEY_TYPE_NAME
      Name of the Resource Key property type.
      See Also:
    • POINTS_TYPE_NAME

      static final String POINTS_TYPE_NAME
      Name of the Points property type.
      See Also:
    • URI_TYPE_NAME

      static final String URI_TYPE_NAME
      Name of the URI property type.
      See Also:
    • DATE_TIME_TYPE_NAME

      static final String DATE_TIME_TYPE_NAME
      Name of the Date Time property type.
      See Also:
    • XML_TYPE_NAME

      static final String XML_TYPE_NAME
      Name of the XML property type.
      See Also:
    • NAME_TYPE_NAME

      static final String NAME_TYPE_NAME
      Name of the Name property type.
      See Also:
    • FLOAT_TYPE_NAME

      static final String FLOAT_TYPE_NAME
      Name of the Float property type.
      See Also:
    • ELEMENT_REF_NAME

      static final String ELEMENT_REF_NAME
      Name of the Element reference property type.
      See Also:
    • STRUCT_TYPE_NAME

      static final String STRUCT_TYPE_NAME
      Name of the Structure property type.
      See Also:
    • EXTENDS_TYPE_NAME

      static final String EXTENDS_TYPE_NAME
      Name of the Extends property type.
      See Also:
    • SCRIPT_TYPE_NAME

      static final String SCRIPT_TYPE_NAME
      Name of the Script property type.
      See Also:
    • STRUCT_REF_TYPE_NAME

      static final String STRUCT_REF_TYPE_NAME
      Name of the structure reference property type.
      See Also:
    • LIST_TYPE_NAME

      static final String LIST_TYPE_NAME
      Name of the list property type.
      See Also:
    • LITERAL_STRING_TYPE_NAME

      static final String LITERAL_STRING_TYPE_NAME
      Name of the Literal String property type.
      See Also:
    • MEMBER_KEY_NAME

      static final String MEMBER_KEY_NAME
      Name the key property type of a structure member.
      See Also:
    • ELEMENT_TYPE_NAME

      static final String ELEMENT_TYPE_NAME
      Name of the element property type.
      See Also:
    • CONTENT_ELEMENT_TYPE_NAME

      static final String CONTENT_ELEMENT_TYPE_NAME
      Type code for element attribute type. This is different from ELEMENT_TYPE. Its behavior like STRUCT_TYPE and isList=true.
      See Also:
    • LOCALE_TYPE_NAME

      static final String LOCALE_TYPE_NAME
      Name of the locale property type.
      See Also:
  • Method Details

    • getDisplayName

      String getDisplayName()
      Returns the localized display name.
      Returns:
      the localized display name
    • getTypeCode

      int getTypeCode()
      Returns the numeric code for this type.
      Returns:
      the internal type code
    • getName

      String getName()
      Returns the name to use in the XML design and XML metadata files.
      Returns:
      the type name used in the XML design file
    • getChoices

      IChoiceSet getChoices()
      Gets the set of choices for this type.
      Returns:
      the set of choices, or null if no choices are available
    • getDisplayNameKey

      String getDisplayNameKey()
      Gets the display name resource key.
      Returns:
      the display name message key