com.cc.framework.ui.painter.html
Class OptionsPainter

java.lang.Object
  com.cc.framework.ui.painter.html.OptionsPainter

public class OptionsPainter

extends java.lang.Object

Painter for an option list The framework supports different data types which can be used to create an option list.

• java.util.Collection
• Array
• java.util.Iterator
• java.util.Map
• java.util.Enumeration
• com.cc.framework.ui.model.OptionListDataModel
• com.cc.framework.ui.model.ListDataModel
• com.cc.framework.ui.model.TreeNodeDataModel
• com.cc.framework.common.SimpleEnumType2

Since:

1.0

Version:

$Revision: 1.36 $

Author:

Harald Schulz

Field Summary

private OptionsComparator	comparator The selected value (the data model)
private java.lang.Object	dataModel The data model
private OptionListDesignModel	designModel The design model

Constructor Summary

OptionsPainter(OptionListDesignModel designModel, java.lang.Object dataModel, OptionsComparator comparator)
Constructor for OptionsPainter

Method Summary

protected void	addOption(java.lang.StringBuffer buf, java.lang.Object value, java.lang.Object label, java.lang.Object tooltip, int indent) Add an option element to the specified StringBuffer based on the specified parameters.
protected void	addOptionScript(java.lang.StringBuffer buf, java.lang.String obj, java.lang.Object value, java.lang.Object label, int indent) Add an option element to the specified StringBuffer based on the specified parameters.
static org.apache.ecs.html.Option	createOption(PainterContext ctx, OptionsIterator iterator, OptionsComparator comparator) Creates an HTML option element from the current iterator position
protected java.lang.StringBuffer	createOptions(javax.servlet.jsp.PageContext ctx, OptionsIterator iter) Method createOptions
protected java.lang.StringBuffer	createOptionsScript(javax.servlet.jsp.PageContext ctx, java.lang.String obj, OptionsIterator iter) Method createOptionsScript
protected boolean	isSelected(java.lang.Object value) Detects if the option is selected
java.lang.String	paint(javax.servlet.jsp.PageContext ctx) Paints the options.
java.lang.String	paint(PainterContext ctx) Paints the options.
java.lang.String	script(javax.servlet.jsp.PageContext ctx, java.lang.String obj) Creates a JavaScript fragment for option list initialization.
java.lang.String	script(PainterContext ctx, java.lang.String obj) Creates a JavaScript fragment for option list initialization.

Methods inherited from class java.lang.Object

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

Field Detail

designModel

private OptionListDesignModel designModel

The design model

dataModel

private java.lang.Object dataModel

The data model

comparator

private OptionsComparator comparator

The selected value (the data model)

Constructor Detail

OptionsPainter

public OptionsPainter(OptionListDesignModel designModel,
                      java.lang.Object dataModel,
                      OptionsComparator comparator)

Constructor for OptionsPainter

Parameters:

designModel - OptionListDesignModel

dataModel - The Options (data model)

comparator - OptionsComparator

Method Detail

paint

public java.lang.String paint(PainterContext ctx)

Paints the options. The framework supports different data types.

Parameters:

ctx - The Painter Context

Returns:

(HTML) String with the option list

paint

public java.lang.String paint(javax.servlet.jsp.PageContext ctx)

Paints the options. The framework supports different data types.

Parameters:

ctx - The JSP Page Context

Returns:

(HTML) String with the option list

script

public java.lang.String script(PainterContext ctx,
                               java.lang.String obj)

Creates a JavaScript fragment for option list initialization.

Parameters:

ctx - The Painter Context

obj - The name of the JavaScript variable that needs to be initialized

Returns:

JavaScript fragment

script

public java.lang.String script(javax.servlet.jsp.PageContext ctx,
                               java.lang.String obj)

Creates a JavaScript fragment for option list initialization.

Parameters:

ctx - The JSP Page Context

obj - The name of the JavaScript variable that needs to be initialized

Returns:

(HTML) String with the option list

isSelected

protected boolean isSelected(java.lang.Object value)

Detects if the option is selected

Parameters:

value - The value which should be check if it's selected

Returns:

boolean true if the option i selected; false otherwise.

createOptions

protected java.lang.StringBuffer createOptions(javax.servlet.jsp.PageContext ctx,
                                               OptionsIterator iter)

Method createOptions

Parameters:

ctx - the JSP page context

iter - Options iterator

Returns:

StringBuffer

addOption

protected void addOption(java.lang.StringBuffer buf,
                         java.lang.Object value,
                         java.lang.Object label,
                         java.lang.Object tooltip,
                         int indent)

Add an option element to the specified StringBuffer based on the specified parameters.

Parameters:

buf - StringBuffer accumulating our results

value - Value to be returned to the server for this option

label - Value to be shown to the user for this option

tooltip - Tooltip to be shown to the user for this option

indent - Indent

createOptionsScript

protected java.lang.StringBuffer createOptionsScript(javax.servlet.jsp.PageContext ctx,
                                                     java.lang.String obj,
                                                     OptionsIterator iter)

Method createOptionsScript

Parameters:

ctx - the JSP page context

obj - The name of the JavaScript variable that needs to be initialized

iter - Options iterator

Returns:

StringBuffer

addOptionScript

protected void addOptionScript(java.lang.StringBuffer buf,
                               java.lang.String obj,
                               java.lang.Object value,
                               java.lang.Object label,
                               int indent)

Add an option element to the specified StringBuffer based on the specified parameters.

Parameters:

buf - StringBuffer accumulating our results

obj - The name of the JavaScript variable that needs to be initialized

value - Value to be returned to the server for this option

label - Value to be shown to the user for this option

indent - Indent

createOption

public static org.apache.ecs.html.Option createOption(PainterContext ctx,
                                                      OptionsIterator iterator,
                                                      OptionsComparator comparator)

Creates an HTML option element from the current iterator position

Parameters:

ctx - the painter context

iterator - the option iterator positioned on the option to paint

comparator - the comparator (or null) to determine the selection state of the current option element

Returns:

HTML option element