Class CmsAttributeConfiguration

  • All Implemented Interfaces:
    com.google.gwt.user.client.rpc.IsSerializable

    public class CmsAttributeConfiguration
    extends java.lang.Object
    implements com.google.gwt.user.client.rpc.IsSerializable
    The attribute configuration. Stating the attribute label, help, widget name and widget configuration.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected CmsAttributeConfiguration()
      Constructor.
        CmsAttributeConfiguration​(java.lang.String label, java.lang.String help, java.lang.String widgetName, java.lang.String widgetConfig, java.lang.String defaultValue, java.lang.String displayType, boolean visible, boolean localSynchronized, boolean dynamicallyLoaded)
      Constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDefaultValue()
      Returns the default value.
      java.lang.String getDisplayType()
      Returns the widget display type.
      java.lang.String getHelp()
      Returns the attribute help information.
      java.lang.String getLabel()
      Returns the attribute label.
      java.lang.String getWidgetConfig()
      Returns the widget configuration.
      java.lang.String getWidgetName()
      Returns the widget name.
      boolean isDisplayColumn()
      Returns the if the widget should be displayed in compact view.
      boolean isDisplaySingleLine()
      Returns true if the widget should be displayed in single line view.
      boolean isDynamicallyLoaded()
      Returns true if the attribute is set dynamically and not from the XML content.
      boolean isLocaleSynchronized()
      Returns if the attribute should be synchronized across all locales.
      boolean isVisible()
      Returns if the given attribute should be visible in the editor.
      void setDisplayType​(java.lang.String displayType)
      Sets the widget display type.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • CmsAttributeConfiguration

        public CmsAttributeConfiguration​(java.lang.String label,
                                         java.lang.String help,
                                         java.lang.String widgetName,
                                         java.lang.String widgetConfig,
                                         java.lang.String defaultValue,
                                         java.lang.String displayType,
                                         boolean visible,
                                         boolean localSynchronized,
                                         boolean dynamicallyLoaded)
        Constructor.

        Parameters:
        label - the attribute label
        help - the attribute help information
        widgetName - the widget name
        widgetConfig - the widget configuration
        defaultValue - the attribute default value
        displayType - the display type
        visible - if the attribute should be visible in the editor
        localSynchronized - if the attribute should be synchronized across all locales
        dynamicallyLoaded - if the attribute should be loaded dynamically
    • Method Detail

      • getDefaultValue

        public java.lang.String getDefaultValue()
        Returns the default value.

        Returns:
        the default value
      • getDisplayType

        public java.lang.String getDisplayType()
        Returns the widget display type.

        Returns:
        the widget display type
      • getHelp

        public java.lang.String getHelp()
        Returns the attribute help information.

        Returns:
        the attribute help information
      • getLabel

        public java.lang.String getLabel()
        Returns the attribute label.

        Returns:
        the attribute label
      • getWidgetConfig

        public java.lang.String getWidgetConfig()
        Returns the widget configuration.

        Returns:
        the widget configuration
      • getWidgetName

        public java.lang.String getWidgetName()
        Returns the widget name.

        Returns:
        the widget name
      • isDisplayColumn

        public boolean isDisplayColumn()
        Returns the if the widget should be displayed in compact view.

        Returns:
        true if the widget should be displayed in compact view
      • isDisplaySingleLine

        public boolean isDisplaySingleLine()
        Returns true if the widget should be displayed in single line view.

        Returns:
        true if the widget should be displayed in single line view
      • isDynamicallyLoaded

        public boolean isDynamicallyLoaded()
        Returns true if the attribute is set dynamically and not from the XML content.

        Returns:
        true if the attribute is set dynamically and not from the XML content
      • isLocaleSynchronized

        public boolean isLocaleSynchronized()
        Returns if the attribute should be synchronized across all locales.

        Returns:
        true if the attribute should be synchronized across all locales
      • isVisible

        public boolean isVisible()
        Returns if the given attribute should be visible in the editor.

        Returns:
        true if the given attribute should be visible in the editor
      • setDisplayType

        public void setDisplayType​(java.lang.String displayType)
        Sets the widget display type.

        Parameters:
        displayType - the widget display type