Package com.adobe.granite.ui.components

Class Options

java.lang.Object
com.adobe.granite.ui.components.Options
Direct Known Subclasses:
ComponentHelper.Options
public class Options extends Object
The class representing the options during Sling include.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Options()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    rootField()
    Returns true if the renderer (the field) should render itself as root field.
    Options
    rootField(boolean flag)
    Sets true to make the renderer (the field) should render itself as root field; false otherwise.
    Tag
    tag()
    Returns the tag.
    Options
    tag(Tag tag)
    Sets the tag.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Options

      public Options()

  • Method Details

    • tag

      @CheckForNull public Tag tag()
      Returns the tag.
      Returns:
      the tag

    • tag

      @Nonnull public Options tag(@CheckForNull Tag tag)
      Sets the tag.
      Parameters:
      tag - the tag
      Returns:
      the options

    • rootField

      public boolean rootField()
      Returns true if the renderer (the field) should render itself as root field. See rootField(boolean) for details.
      Returns:
      true if the renderer (the field) should render itself as root field.

    • rootField

      @Nonnull public Options rootField(boolean flag)
      Sets true to make the renderer (the field) should render itself as root field; false otherwise.

      A root field is a field that acts in its own context, instead of as part of a composite field. For example, sizing field consists of weight and height fields. So sizing field is a composite field and wants to leverage the existing number field for width and height. In this case when sizing field is including ( ComponentHelper.include(org.apache.sling.api.resource.Resource, ComponentHelper.Options)) the number field, it should set this option as false.

      The field implementation is free to interpret the exact behaviour of root/non-root field. Most likely scenario, the root field will handle it own sizing state (e.g. inline-block/block state), while non root field will not, where the parent composite field is managing it.

      Parameters:
      flag - the flag
      Returns:
      this instance