org.openmrs.web.attribute.handler

Class LongFreeTextTextareaHandler

java.lang.Object

org.openmrs.web.attribute.handler.LongFreeTextTextareaHandler

All Implemented Interfaces:

CustomDatatypeHandler<CustomDatatype<java.lang.String>,java.lang.String>, DownloadableDatatypeHandler<java.lang.String>, HtmlDisplayableDatatypeHandler<java.lang.String>, WebDatatypeHandler<LongFreeTextDatatype,java.lang.String>

@Component
public class LongFreeTextTextareaHandler
extends java.lang.Object
implements WebDatatypeHandler<LongFreeTextDatatype,java.lang.String>, DownloadableDatatypeHandler<java.lang.String>

Handler for the LongFreeTextDatatype that displays as a textarea.

Since:

1.9

Constructor Summary

Constructors

Constructor and Description
LongFreeTextTextareaHandler()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getContentType(CustomDatatype<java.lang.String> dt, java.lang.String valueReference)
java.lang.String	getFilename(CustomDatatype<java.lang.String> dt, java.lang.String valueReference)
java.lang.String	getValue(LongFreeTextDatatype datatype, javax.servlet.http.HttpServletRequest request, java.lang.String formFieldName) Handles a form submission including a widget generated by this handler
java.lang.String	getWidgetHtml(LongFreeTextDatatype datatype, java.lang.String formFieldName, java.lang.String widgetId, java.lang.String startingValue) Generates the HTML for a widget
void	setHandlerConfiguration(java.lang.String handlerConfig) An AttributeType will typically be configured with a handler and a configuration.
java.lang.String	toHtml(CustomDatatype<java.lang.String> datatype, java.lang.String valueReference) Renders the full view of a custom value, as HTML.
CustomDatatype.Summary	toHtmlSummary(CustomDatatype<java.lang.String> datatype, java.lang.String valueReference) Renders an HTML-formatted summary view of the custom value, that does not take a lot of space.
void	writeToStream(CustomDatatype<java.lang.String> dt, java.lang.String valueReference, java.io.OutputStream os) Writes the custom value to os.

Methods inherited from class java.lang.Object

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

Constructor Detail

LongFreeTextTextareaHandler

public LongFreeTextTextareaHandler()

Method Detail

setHandlerConfiguration

public void setHandlerConfiguration(java.lang.String handlerConfig)

Description copied from interface: CustomDatatypeHandler

An AttributeType will typically be configured with a handler and a configuration. The framework takes care of constructing a handler, and setting its configuration (if any)

Specified by:

setHandlerConfiguration in interface CustomDatatypeHandler<CustomDatatype<java.lang.String>,java.lang.String>

See Also:

CustomDatatypeHandler.setHandlerConfiguration(java.lang.String)

toHtmlSummary

public CustomDatatype.Summary toHtmlSummary(CustomDatatype<java.lang.String> datatype,
                                            java.lang.String valueReference)

Description copied from interface: HtmlDisplayableDatatypeHandler

Renders an HTML-formatted summary view of the custom value, that does not take a lot of space. (This is subjective, but generally means < 100 characters in length, or an image of < 200 pixels in each dimension.) This method should return quickly, e.g. in case we're rendering thousands of custom values in a table.

Specified by:

toHtmlSummary in interface HtmlDisplayableDatatypeHandler<java.lang.String>

Returns:

an HTML-formatted summary view of valueReference

See Also:

HtmlDisplayableDatatypeHandler.toHtmlSummary(org.openmrs.customdatatype.CustomDatatype, java.lang.String)

toHtml

public java.lang.String toHtml(CustomDatatype<java.lang.String> datatype,
                               java.lang.String valueReference)

Description copied from interface: HtmlDisplayableDatatypeHandler

Renders the full view of a custom value, as HTML.

Specified by:

toHtml in interface HtmlDisplayableDatatypeHandler<java.lang.String>

Returns:

an HTML-formatted full view of valueReference

See Also:

HtmlDisplayableDatatypeHandler.toHtml(org.openmrs.customdatatype.CustomDatatype, java.lang.String)

getWidgetHtml

public java.lang.String getWidgetHtml(LongFreeTextDatatype datatype,
                                      java.lang.String formFieldName,
                                      java.lang.String widgetId,
                                      java.lang.String startingValue)

Description copied from interface: WebDatatypeHandler

Generates the HTML for a widget

Specified by:

getWidgetHtml in interface WebDatatypeHandler<LongFreeTextDatatype,java.lang.String>

Parameters:

datatype - the underlying datatype for this widget

formFieldName - the name the widget should submit with

widgetId - a unique id, generated by the web framework, that the widget should use

startingValue - the initial value for the generated HTML

Returns:

HTML for editing/creating a value of this datatype

See Also:

WebDatatypeHandler.getWidgetHtml(org.openmrs.customdatatype.CustomDatatype, java.lang.String, java.lang.String, java.lang.Object)

getValue

public java.lang.String getValue(LongFreeTextDatatype datatype,
                                 javax.servlet.http.HttpServletRequest request,
                                 java.lang.String formFieldName)
                          throws InvalidCustomValueException

Description copied from interface: WebDatatypeHandler

Handles a form submission including a widget generated by this handler

Specified by:

getValue in interface WebDatatypeHandler<LongFreeTextDatatype,java.lang.String>

Parameters:

datatype - the underlying datatype for this widget

request - the submitted HTTP request

formFieldName - the same value passed to WebDatatypeHandler.getWidgetHtml(CustomDatatype, String, String, Object) when generating this widget

Returns:

a parsed and validated value submitted by the widget

Throws:

InvalidCustomValueException

See Also:

WebDatatypeHandler.getValue(org.openmrs.customdatatype.CustomDatatype, javax.servlet.http.HttpServletRequest, java.lang.String)

getContentType

public java.lang.String getContentType(CustomDatatype<java.lang.String> dt,
                                       java.lang.String valueReference)

Specified by:

getContentType in interface DownloadableDatatypeHandler<java.lang.String>

Parameters:

dt - the datatype this handler handles

valueReference - custom value to be downloaded

Returns:

the MIME type that should be communicated to any client downloading the given custom value. Should not return null.

See Also:

DownloadableDatatypeHandler.getContentType(org.openmrs.customdatatype.CustomDatatype, java.lang.String)

getFilename

public java.lang.String getFilename(CustomDatatype<java.lang.String> dt,
                                    java.lang.String valueReference)

Specified by:

getFilename in interface DownloadableDatatypeHandler<java.lang.String>

Parameters:

dt - the datatype this handler handles

valueReference - custom value to be downloaded

Returns:

the filename that should be communicated to any client downloading the given custom value. May return null, in which case the framework will choose a meaningless filename.

See Also:

DownloadableDatatypeHandler.getFilename(org.openmrs.customdatatype.CustomDatatype, java.lang.String)

writeToStream

public void writeToStream(CustomDatatype<java.lang.String> dt,
                          java.lang.String valueReference,
                          java.io.OutputStream os)
                   throws java.io.IOException

Description copied from interface: DownloadableDatatypeHandler

Writes the custom value to os. Implementations should assume that the caller has set up the stream, calling getMimeType and getFilename if necessary. Implementations should assume that the caller has taken care of any needed buffering on os.

Specified by:

writeToStream in interface DownloadableDatatypeHandler<java.lang.String>

Parameters:

dt - the datatype this handler handles

valueReference - custom value to be written to os

os - the output stream to be written to

Throws:

java.io.IOException - if there is an IO error writing to the stream

See Also:

DownloadableDatatypeHandler.writeToStream(org.openmrs.customdatatype.CustomDatatype, java.lang.String, java.io.OutputStream)