dk.heick.properties.web.renderer

Interface PropertyTypeRenderer

All Known Implementing Classes:

AbstractDropdownRenderer, AbstractInputTextRenderer, BooleanDropdownRenderer, ByteSizeRenderer, CharsetRenderer, CountryLocaleDropdownRenderer, DateTimeRenderer, DerivedRenderer, EnumDropdownRenderer, FilenameFilterRenderer, FileStructureRenderer, FontRenderer, GenericInputTextRenderer, HourIntervalsRenderer, KeyValueRenderer, LatLngRenderer, ListRenderer, PasswordRenderer, Point2DRenderer, Point3DRenderer, ProxyRenderer, RangeRenderer, SequenceRenderer, StringPropertiesRenderer, StringRenderer, TimeZoneDropDownRenderer, UnknownPropertyTypeRenderer

public interface PropertyTypeRenderer

The class PropertyCollectionRenderer renders all the properties, but when the actual value of property shall be renderer it is dependant on
the PropertyType, hence using the registered PropertyTypeRenderer for the Property's PropertyType.

There are for methods to implement:

• renderReadonly : Render the value as readonly. Typical the value in a <pre> tag.
• renderWriteable : Render the value as writable, this is typical in a FORM, with a SET WebAction, but there can be actions like DELETE, MOVEUP etc.
• handle : Handle all the different WebActions setup in the "renderWriteable".
• renderPropertyTypeRestrictions : Since some of the PropertyType has some really lengthy descriptions, this is the possibility to limit the text output.

The handling and rendering of a PropertyType.
This shall renderer the single field where the value of a property will be renderer.
Both where it is displayed readonly and where it is writable.
When it is writable the handle must handle the actions defined in the writable HTML part.
This HIGHLY dependant on AbstractPropertyCollectionHandlingServlet, WebAction and WebName.

Since:

1.1

Author:

Frederik Heick

See Also:

AbstractPropertyCollectionHandlingServlet, WebAction, WebName

Method Summary

Modifier and Type	Method and Description
org.apache.commons.logging.Log	getLogger() Gets a Log for logging.
void	handle(dk.heick.properties.PropertyCollection collection, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Will get the Property by the name from the FORM WebName.PROPERTY_NAME.
String	renderPropertyTypeRestrictions(dk.heick.properties.Property<?> property, String cssClass) Rendering the property type restrictions.
String	renderReadonly(dk.heick.properties.Property<?> property, String cssClass) Render the property value as readonly.
String	renderWriteable(dk.heick.properties.Property<?> property, String handleUrl, String cssClass) Render form/forms to handle editing of the propety type.

Method Detail

handle

void handle(dk.heick.properties.PropertyCollection collection,
            javax.servlet.http.HttpServletRequest request,
            javax.servlet.http.HttpServletResponse response)
     throws Exception

Will get the Property by the name from the FORM WebName.PROPERTY_NAME. The value from WebName.PROPERTY_VALUE. If no WebAction is set, WebAction.SET is assumed.

Parameters:

collection - the property collection

request - the request

response - the response

Throws:

Exception - if an error occures.

renderReadonly

String renderReadonly(dk.heick.properties.Property<?> property,
                      String cssClass)

Render the property value as readonly.

Parameters:

property - the property

cssClass - use to color the cell, so alternate coloring is shown.

Returns:

the HTML string

renderWriteable

String renderWriteable(dk.heick.properties.Property<?> property,
                       String handleUrl,
                       String cssClass)

Render form/forms to handle editing of the propety type.

Parameters:

property - the property

handleUrl - the URL which called by the forms to alter properties. Usually the servlet URL for the implementation of AbstractPropertyCollectionHandlingServlet.

cssClass - use to color the cell, so alternate coloring is shown.

Returns:

the HTML string

See Also:

AbstractPropertyCollectionHandlingServlet

renderPropertyTypeRestrictions

String renderPropertyTypeRestrictions(dk.heick.properties.Property<?> property,
                                      String cssClass)

Rendering the property type restrictions. Usually just the default rendering in the WebUtils.

Parameters:

property - the property

cssClass - use to color the cell, so alternate coloring is shown.

Returns:

the restrictions.

See Also:

WebUtils.renderPropertyTypeRestrictions(Property)

getLogger

org.apache.commons.logging.Log getLogger()

Gets a Log for logging.

Returns:

a Log instance.

See Also:

Log