Package com.ptc.mvc.components

Interface PropertyConfig

All Superinterfaces:
ComponentConfig
All Known Subinterfaces:
AttributeConfig, ColumnConfig
All Known Implementing Classes:
JcaColumnConfig, JcaPropertyConfig
public interface PropertyConfig extends ComponentConfig
Describes a property of a component
Supported API: true

Extendable: false

  • Method Details

    • getCharacterEntryLimit

      int getCharacterEntryLimit()
      returns max string entry length for text input field.

      Supported API: true
      Returns:
      integer

    • setCharacterEntryLimit

      void setCharacterEntryLimit(int characterEntryLimit)
      sets the max string entry length for text input field.

      Supported API: true
      Parameters:
      characterEntryLimit -

    • getCurrency

      String getCurrency()
      This determines if a numeric value should be displayed in currency format (applicable to numeric fields only).

      Supported API: true
      Returns:
      String

    • setCurrency

      void setCurrency(String currency)
      sets value which determines if a numeric value should be displayed in currency format (applicable to numeric fields only).

      Supported API: true
      Parameters:
      currency -

    • getDataUtilityId

      String getDataUtilityId()
      returns the id to use for data utility lookup.

      Supported API: true
      Returns:
      String

    • setDataUtilityId

      void setDataUtilityId(String duid)
      sets the id to use for data utility lookup.

      Supported API: true
      Parameters:
      duid -

    • getDateDisplayFormat

      String getDateDisplayFormat()
      This is the format string used to format a timestamp value.

      Supported API: true
      Returns:
      String

    • setDateDisplayFormat

      void setDateDisplayFormat(String dateDisplayFormat)
      sets the format string used to format a timestamp value.

      Supported API: true
      Parameters:
      dateDisplayFormat -

    • getDateInputFieldType

      String getDateInputFieldType()
      This determines if a date input field should be displayed as a DateOnly/DateTime field.

      Supported API: true
      Returns:
      String

    • setDateInputFieldType

      void setDateInputFieldType(String dateInputFieldType)
      returns value that determines if a date input field should be displayed as a DateOnly/DateTime field.

      Supported API: true
      Parameters:
      dateInputFieldType -

    • getDefaultValueDisplayMode

      String getDefaultValueDisplayMode()
      The mode of displaying the default value of an attribute.

      Supported API: true
      Returns:
      String

    • setDefaultValueDisplayMode

      void setDefaultValueDisplayMode(String defaultValueDisplayMode)
      sets the mode of displaying the default value of an attribute.

      Supported API: true
      Parameters:
      defaultValueDisplayMode -

    • getDisplayLengthInInfoPage

      String getDisplayLengthInInfoPage()
      returns the truncation length for values displayed in an info page.

      Supported API: true
      Returns:
      string

    • setDisplayLengthInInfoPage

      void setDisplayLengthInInfoPage(String displayLengthInInfoPage)
      sets the truncation length for values displayed in an info page.

      Supported API: true
      Parameters:
      displayLengthInInfoPage -

    • getDisplayLengthInTables

      String getDisplayLengthInTables()
      returns the truncation length for values displayed in a table.

      Supported API: true
      Returns:
      string

    • setDisplayLengthInTables

      void setDisplayLengthInTables(String displayLengthInTables)
      sets the truncation length for values displayed in a table.

      Supported API: true
      Parameters:
      displayLengthInTables -

    • isDistinguishWIPVersions

      boolean isDistinguishWIPVersions()
      When true, this attribute indicates that glyphs returned by the general status data utility should distinguish between checked-out original and working copy. If false (or not-specified), only "working copy" will be displayed

      Supported API: true
      Returns:
      boolean

    • setDistinguishWIPVersions

      void setDistinguishWIPVersions(boolean distinguishWIPVersions)


      Supported API: true
      Parameters:
      distinguishWIPVersions -
      See Also:

    • getHtmlId

      String getHtmlId()
      returns the string to be used as the id of the corresponding HTML element.

      Supported API: true
      Returns:
      String

    • setHtmlId

      void setHtmlId(String htmlId)


      Supported API: true
      Parameters:
      htmlId -
      See Also:

    • getInputFieldType

      String getInputFieldType()
      Specify whether the attribute should be displayed as a single-line or multi-line input field (applicable to string attributes only). This directive will override that of the stringLengthThreshholdForMultilineInput preference.

      Supported API: true
      Returns:
      String

    • setInputFieldType

      void setInputFieldType(String inputFieldType)


      Supported API: true
      Parameters:
      inputFieldType -
      See Also:

    • getInputRequired

      String getInputRequired()
      Indicates whether a value must be entered for an input field.

      Supported API: true
      Returns:
      String

    • setInputRequired

      void setInputRequired(String inputRequired)


      Supported API: true
      Parameters:
      inputRequired -
      See Also:

    • getNeed

      String getNeed()
      Returns the first model attribute needed for this property.

      Supported API: true
      Returns:
      String

    • getNeedList

      List<String> getNeedList()
      Returns the list of model attributes needed for this property.

      Supported API: true

    • setNeed

      void setNeed(String need)
      Sets the model attributes needed for this config. Model attributes are used (1) when the property has an id that doesn't map to the way the attribute is defined either by introspection or by logical attributes and (2) when multiple attribute values are needed to display column cells. To specify multiple model attributes, use a comma-separated list.

      Supported API: true
      Parameters:
      need -

    • getPercent

      String getPercent()
      This determines if a numeric value should be displayed in percent format (applicable to numeric fields only).

      Supported API: true
      Returns:
      string

    • setPercent

      void setPercent(String percent)


      Supported API: true
      Parameters:
      percent -
      See Also:

    • getSelectionListStyle

      String getSelectionListStyle()
      The style in which the list of choices for an attribute value are to be displayed.

      Supported API: true
      Returns:
      String

    • setSelectionListStyle

      void setSelectionListStyle(String selectionListStyle)


      Supported API: true
      Parameters:
      selectionListStyle -
      See Also:

    • getSeparatorType

      String getSeparatorType()
      separator drawn between the attributes by model. The default is none.

      Supported API: true
      Returns:
      String

    • setSeparatorType

      void setSeparatorType(String seperatorType)


      Supported API: true
      Parameters:
      seperatorType -
      See Also:

    • getStringLengthThreshholdForMultilineInput

      String getStringLengthThreshholdForMultilineInput()
      The string length threshhold that determines if a multi-line input field should be used (applicable to string attributes only).

      Supported API: true
      Returns:
      String

    • setStringLengthThreshholdForMultilineInput

      void setStringLengthThreshholdForMultilineInput(String threshholdForMultiLineInput)


      Supported API: true
      Parameters:
      threshholdForMultiLineInput -
      See Also:

    • getTextInputColumns

      int getTextInputColumns()
      columns of text input field (applicable to textfields and multi-line input fields only).

      Supported API: true
      Returns:
      integer

    • setTextInputColumns

      void setTextInputColumns(int textInputColumns)


      Supported API: true
      Parameters:
      textInputColumns -
      See Also:

    • getTextInputRows

      int getTextInputRows()
      rows of text input field (applicable to multi-line input fields only).

      Supported API: true
      Returns:
      integer

    • setTextInputRows

      void setTextInputRows(int textInputRows)


      Supported API: true
      Parameters:
      textInputRows -
      See Also:

    • isHidden

      boolean isHidden()
      When true, the column will not be shown in the displayed

      Supported API: true
      Returns:
      boolean

    • setHidden

      void setHidden(boolean hidden)


      Supported API: true
      Parameters:
      hidden -
      See Also:

    • isInfoPageLink

      boolean isInfoPageLink()
      Overrides the default behavior of the column/property to add or remove a hyperlink to the info page of the context object this attribute is only applicable for certain columns/properties like name and number. By default the number is a hyperlink to the info page and name is not.

      Supported API: true
      Returns:
      boolean

    • setInfoPageLink

      void setInfoPageLink(boolean infoPageLink)


      Supported API: true
      Parameters:
      infoPageLink -
      See Also:

    • isRenderAllStates

      boolean isRenderAllStates()
      This determines if all Lifecycle States should be rendered (applicable to lifeCycleState fields only).

      Supported API: true
      Returns:
      boolean

    • setRenderAllStates

      void setRenderAllStates(boolean renderAllStates)


      Supported API: true
      Parameters:
      renderAllStates -
      See Also:

    • isRequired

      boolean isRequired()
      Whether or not each row object must define this attribute. Note that setting this to <code>true</code> does not guarantee a non-null value, it just ensures that the type definition for each row object defines the property

      Supported API: true
      Returns:
      boolean

    • setRequired

      void setRequired(boolean required)


      Supported API: true
      Parameters:
      required -
      See Also:

    • isStatusGlyph

      boolean isStatusGlyph()
      checks whether the property is actually the statusGlyph

      Supported API: true
      Returns:
      boolean

    • setStatusGlyph

      void setStatusGlyph(boolean statusGlyph)


      Supported API: true
      Parameters:
      statusGlyph -
      See Also:

    • includeBlankOption

      boolean includeBlankOption()
      Overrides the default behavior of the column/property to include/exclude a blank entry (or an Undefined radio button) to the selection list of an attribute. This attribute is only applicable for columns/properties that have a selection list. By default, a blank entry (or an Undefined radio button) is included as the first element of the selection list.

      Supported API: true
      Returns:
      boolean

    • setIncludeBlankOption

      void setIncludeBlankOption(boolean includeBlank)


      Supported API: true
      Parameters:
      includeBlank -
      See Also: