Package io.wcm.handler.richtext

Class RichTextRequest

java.lang.Object

io.wcm.handler.richtext.RichTextRequest

@ProviderType
public final class RichTextRequest
extends java.lang.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 java.lang.String text, @Nullable io.wcm.handler.url.UrlMode urlMode, @Nullable TextMode textMode, @Nullable io.wcm.handler.media.MediaArgs mediaArgs)

Method Summary

Modifier and Type	Method	Description
@Nullable io.wcm.handler.media.MediaArgs	getMediaArgs()
@Nullable org.apache.sling.api.resource.Resource	getResource()
@NotNull org.apache.sling.api.resource.ValueMap	getResourceProperties()
@Nullable java.lang.String	getText()
@Nullable TextMode	getTextMode()
@Nullable io.wcm.handler.url.UrlMode	getUrlMode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RichTextRequest

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

Parameters:

resource - Resource containing rich text

text - Raw rich text

urlMode - URL mode

textMode - Text mode

mediaArgs - Media arguments

Method Detail

getResource

@Nullable
public @Nullable org.apache.sling.api.resource.Resource getResource()

Returns:

Resource containing rich text

getText

@Nullable
public @Nullable java.lang.String getText()

Returns:

Raw rich text

getUrlMode

@Nullable
public @Nullable io.wcm.handler.url.UrlMode getUrlMode()

Returns:

URL mode

getTextMode

@Nullable
public @Nullable TextMode getTextMode()

Returns:

Text mode

getMediaArgs

@Nullable
public @Nullable io.wcm.handler.media.MediaArgs getMediaArgs()

Returns:

Media arguments

getResourceProperties

@NotNull
public @NotNull org.apache.sling.api.resource.ValueMap getResourceProperties()

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 java.lang.String toString()

Overrides:

toString in class java.lang.Object