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 final String
    PN_CSS_CLASS
    default property name to store component style cssc class names

  • Method Summary

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

    Methods inherited from interface com.day.cq.commons.JSONItem

    write

  • Field Details

    • PN_CSS_CLASS

      static final String PN_CSS_CLASS
      default property name to store component style cssc class names
      See Also:

  • Method Details

    • getName

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

    • getPath

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

    • getTitle

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

    • getDescription

      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.