Package com.day.cq.wcm.api.designer

Interface ComponentStyle

  • All Superinterfaces:
    JSONItem
    public interface ComponentStyle
extends JSONItem
    Defines a component style that is usually stored in the design. The component styles are stored in the "cq:cssClass" property and automatically added to the component css during the component include.
    Since:
    5.4

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static interface  ComponentStyle.Option
      define a selectable style option

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String PN_CSS_CLASS
      default property name to store component style cssc class names

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Returns the display description of this component style.
      java.lang.String getName()
      Returns the name of this component style
      ComponentStyle.Option[] getOptions()
      Returns an array of selectable style options
      java.lang.String getPath()
      Returns the path where this component style is stored.
      java.lang.String getTitle()
      Returns the display title of this component style.

    • Field Detail

      • PN_CSS_CLASS

        static final java.lang.String PN_CSS_CLASS
        default property name to store component style cssc class names
        See Also:
        Constant Field Values

    • Method Detail

      • getName

        java.lang.String getName()
        Returns the name of this component style
        Returns:
        the name

      • getPath

        java.lang.String getPath()
        Returns the path where this component style is stored.
        Returns:
        the path.

      • getTitle

        java.lang.String getTitle()
        Returns the display title of this component style.
        Returns:
        the title

      • getDescription

        java.lang.String getDescription()
        Returns the display description of this component style.
        Returns:
        the description

      • getOptions

        ComponentStyle.Option[] getOptions()
        Returns an array of selectable style options
        Returns:
        the options.