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 and Description
RichTextRequest(org.apache.sling.api.resource.Resource resource, String text, io.wcm.handler.url.UrlMode urlMode, TextMode textMode, io.wcm.handler.media.MediaArgs mediaArgs)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RichTextRequest

public RichTextRequest(org.apache.sling.api.resource.Resource resource,
                       String text,
                       io.wcm.handler.url.UrlMode urlMode,
                       TextMode textMode,
                       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

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

Returns:

Resource containing rich text

getText

public String getText()

Returns:

Raw rich text

getUrlMode

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

Returns:

URL mode

getTextMode

public TextMode getTextMode()

Returns:

Text mode

getMediaArgs

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

Returns:

Media arguments

getResourceProperties

public 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 String toString()

Overrides:

toString in class Object