Package io.wcm.handler.richtext

Class RichTextRequest

java.lang.Object
io.wcm.handler.richtext.RichTextRequest
@ProviderType public final class RichTextRequest extends Object
Holds all properties that are part of a rich text handling request.

  • Constructor Summary

    Constructors
    Constructor
    Description
    RichTextRequest(@Nullable org.apache.sling.api.resource.Resource resource, @Nullable String text, @Nullable io.wcm.handler.url.UrlMode urlMode, @Nullable TextMode textMode, @Nullable io.wcm.handler.media.MediaArgs mediaArgs)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable io.wcm.handler.media.MediaArgs
    getMediaArgs()
    Gets the media arguments.
    @Nullable org.apache.sling.api.resource.Resource
    getResource()
    Gets the resource containing rich text.
    @NotNull org.apache.sling.api.resource.ValueMap
    getResourceProperties()
    Gets the properties from resource containing rich text.
    @Nullable String
    getText()
    Gets the raw rich text.
    @Nullable TextMode
    getTextMode()
    Gets the text mode.
    @Nullable io.wcm.handler.url.UrlMode
    getUrlMode()
    Gets the URL mode.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • RichTextRequest

      public RichTextRequest(@Nullable @Nullable org.apache.sling.api.resource.Resource resource, @Nullable @Nullable String text, @Nullable @Nullable io.wcm.handler.url.UrlMode urlMode, @Nullable @Nullable TextMode textMode, @Nullable @Nullable io.wcm.handler.media.MediaArgs mediaArgs)
      Constructor.
      Parameters:
      resource - Resource containing rich text
      text - Raw rich text
      urlMode - URL mode
      textMode - Text mode
      mediaArgs - Media arguments

  • Method Details

    • getResource

      @Nullable public @Nullable org.apache.sling.api.resource.Resource getResource()
      Gets the resource containing rich text.
      Returns:
      Resource containing rich text

    • getText

      @Nullable public @Nullable String getText()
      Gets the raw rich text.
      Returns:
      Raw rich text

    • getUrlMode

      @Nullable public @Nullable io.wcm.handler.url.UrlMode getUrlMode()
      Gets the URL mode.
      Returns:
      URL mode

    • getTextMode

      @Nullable public @Nullable TextMode getTextMode()
      Gets the text mode.
      Returns:
      Text mode

    • getMediaArgs

      @Nullable public @Nullable io.wcm.handler.media.MediaArgs getMediaArgs()
      Gets the media arguments.
      Returns:
      Media arguments

    • getResourceProperties

      @NotNull public @NotNull org.apache.sling.api.resource.ValueMap getResourceProperties()
      Gets the properties from resource containing rich text.
      Returns:
      Properties from resource containing rich text. The value map is a copy of the original map so it is safe to change the property values contained in the map.

    • toString

      public String toString()
      Overrides:
      toString in class Object