org.openmrs.web.attribute.handler

Class DateFieldGenDatatypeHandler

java.lang.Object

org.openmrs.web.attribute.handler.DateFieldGenDatatypeHandler

All Implemented Interfaces:

CustomDatatypeHandler<CustomDatatype<java.util.Date>,java.util.Date>, FieldGenDatatypeHandler<DateDatatype,java.util.Date>, HtmlDisplayableDatatypeHandler<java.util.Date>

@Component
public class DateFieldGenDatatypeHandler
extends java.lang.Object
implements FieldGenDatatypeHandler<DateDatatype,java.util.Date>

A fieldgen version of a DateAttributeHandler that uses the standard Date picker widget.

Since:

1.9

Constructor Summary

Constructors

Constructor and Description
DateFieldGenDatatypeHandler()

Method Summary

Modifier and Type	Method and Description
java.util.Date	getValue(DateDatatype datatype, javax.servlet.http.HttpServletRequest request, java.lang.String formFieldName) Fetches an attribute value from a web request, for a given form field name
java.util.Map<java.lang.String,java.lang.Object>	getWidgetConfiguration()
java.lang.String	getWidgetName()
void	setHandlerConfiguration(java.lang.String arg0) An AttributeType will typically be configured with a handler and a configuration.
java.lang.String	toHtml(CustomDatatype<java.util.Date> datatype, java.lang.String valueReference) Renders the full view of a custom value, as HTML.
CustomDatatype.Summary	toHtmlSummary(CustomDatatype<java.util.Date> datatype, java.lang.String valueReference) Renders an HTML-formatted summary view of the custom value, that does not take a lot of space.

Methods inherited from class java.lang.Object

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

Constructor Detail

DateFieldGenDatatypeHandler

public DateFieldGenDatatypeHandler()

Method Detail

setHandlerConfiguration

public void setHandlerConfiguration(java.lang.String arg0)

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.util.Date>,java.util.Date>

See Also:

CustomDatatypeHandler.setHandlerConfiguration(java.lang.String)

getWidgetName

public java.lang.String getWidgetName()

Specified by:

getWidgetName in interface FieldGenDatatypeHandler<DateDatatype,java.util.Date>

Returns:

the name of the fieldgen widget to be used to allow data entry for attribute types that use this handler

See Also:

FieldGenDatatypeHandler.getWidgetName()

getWidgetConfiguration

public java.util.Map<java.lang.String,java.lang.Object> getWidgetConfiguration()

Specified by:

getWidgetConfiguration in interface FieldGenDatatypeHandler<DateDatatype,java.util.Date>

Returns:

extra configuration properties to be passed to the fieldgen widget

See Also:

FieldGenDatatypeHandler.getWidgetConfiguration()

getValue

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

Description copied from interface: FieldGenDatatypeHandler

Fetches an attribute value from a web request, for a given form field name

Specified by:

getValue in interface FieldGenDatatypeHandler<DateDatatype,java.util.Date>

Returns:

Throws:

InvalidCustomValueException

See Also:

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

toHtmlSummary

public CustomDatatype.Summary toHtmlSummary(CustomDatatype<java.util.Date> 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.util.Date>

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.util.Date> 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.util.Date>

Returns:

an HTML-formatted full view of valueReference

See Also:

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