Package com.adobe.acs.commons.mcp.form

Class FieldComponent

java.lang.Object
com.adobe.acs.commons.mcp.form.FieldComponent
Direct Known Subclasses:
AbstractContainerComponent, AutocompleteComponent, ButtonComponent, CheckboxComponent, DatePickerComponent, FileUploadComponent, NumberfieldComponent, PasswordComponent, PathfieldComponent, RadioComponent, RichTextEditorComponent, SelectComponent, TagPickerComponent, TextfieldComponent
public abstract class FieldComponent extends Object
Describes a component in a manner which supports auto-generated forms

  • Constructor Details

    • FieldComponent

      public FieldComponent()

  • Method Details

    • setup

      public final void setup(String name, AccessibleObject fieldOrMethod, FormField field, org.apache.sling.api.scripting.SlingScriptHelper sling)

    • init

      public abstract void init()

    • setHelper

      public final void setHelper(org.apache.sling.api.scripting.SlingScriptHelper helper)

    • getHelper

      public final org.apache.sling.api.scripting.SlingScriptHelper getHelper()

    • setPath

      public final void setPath(String path)

    • getPath

      public final String getPath()

    • getAccessibleObject

      public final AccessibleObject getAccessibleObject()

    • getFieldDefinition

      public final FormField getFieldDefinition()

    • getHtml

      public final String getHtml()

    • buildComponentResource

      public org.apache.sling.api.resource.Resource buildComponentResource()
      If your component needs child nodes then override this method, call the superclass implementation, and then use addChildren to add additional nodes to it.
      Returns:

    • getProperties

      public final Map<String,Object> getProperties()
      Returns:
      the component's properties

    • getClientLibraryCategories

      public final Map<FieldComponent.ClientLibraryType,Set<String>> getClientLibraryCategories()

    • addClientLibrary

      public final void addClientLibrary(String category)

    • addClientLibraries

      public final void addClientLibraries(FieldComponent.ClientLibraryType type, String... categories)

    • addClientLibraries

      public final void addClientLibraries(FieldComponent.ClientLibraryType type, Collection<String> categories)

    • addClientLibraries

      public final void addClientLibraries(FieldComponent component)

    • getResourceType

      public final String getResourceType()
      Returns:
      the resourceType

    • setResourceType

      public final void setResourceType(String resourceType)
      Parameters:
      resourceType - the resourceType to set

    • getResourceSuperType

      public final String getResourceSuperType()
      Returns:
      the resourceSuperType

    • setResourceSuperType

      public final void setResourceSuperType(String resourceSuperType)
      Parameters:
      resourceSuperType - the resourceSuperType to set

    • purgeEmptyProperties

      public final void purgeEmptyProperties()

    • getName

      public final String getName()
      Returns:
      the name

    • getOptionNames

      public final Collection<String> getOptionNames()

    • hasOption

      public final boolean hasOption(String optionName)

    • getOption

      public final Optional<String> getOption(String option)

    • getBooleanOption

      public final Optional<Boolean> getBooleanOption(String option)

    • getCategory

      public final String getCategory()
      Returns:
      the category

    • setCategory

      public final void setCategory(String category)
      Parameters:
      category - the category to set