summaryrefslogtreecommitdiff
path: root/projects/net.wotonomy.web/src/main/java/net/wotonomy/web/WOString.java
blob: ef5b7716ed73caa3bc4667cc8552a88c6afc2be1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/*
Wotonomy: OpenStep design patterns for pure Java applications.
Copyright (C) 2000 Blacksmith, Inc.

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, see http://www.gnu.org
*/

package net.wotonomy.web;

import java.text.Format;

import net.wotonomy.foundation.NSDictionary;
import net.wotonomy.foundation.NSNumberFormatter;
import net.wotonomy.foundation.NSTimestampFormatter;

/**
* WOString renders a dynamically generated string in the output.
* Bindings are:
* <ul>
* <li>value: a property returning a value which will be rendered as the 
* output.  If a formatter is not used, then the value must be convertable
* to a String with toString().</li>
* <li>escapeHTML: a property returning a value convertable to a Boolean
* indicating whether the any html characters in the output should be
* escaped so they are shown as html characters rather than interpreted
* as html.</li>
* <li>formatter: a property returning a Format object that will be
* used to format the value into a String.</li>
* <li>dateformat: a property returning a DateFormat object that will be
* used to format the value into a String.</li>
* <li>numberformat: a property returning a NumberFormat object that will be
* used to format the value into a String.  Not yet implemented.</li>
* <li>valueWhenEmpty: a property returning a String that will be used
* in place of an empty or null value.  Not yet implemented.</li>
* </ul>
*
* @author michael@mpowers.net
* @author $Author: cgruber $
* @version $Revision: 905 $
*/
public class WOString extends WODynamicElement
{
	protected Object value;
	protected boolean escapeHTML;
	protected Format formatter;
	protected String dateformat;
	protected String numberformat;
    protected Object valueWhenEmpty;

	/**
	* The default constructor.
	*/
    protected WOString ()
    {
    }
    
    public WOString (
    	String aName, NSDictionary anAssociationMap, WOElement aRootElement)
    {
    	super( aName, anAssociationMap, aRootElement );
	    escapeHTML = true;
    }

    public void appendToResponse (WOResponse aResponse, WOContext aContext)
    {	
        WOComponent c = aContext.component();
        numberformat = stringForProperty("numberformat", c );
        dateformat = stringForProperty("dateformat", c );
        formatter = (Format) valueForProperty("formatter", c );
        escapeHTML = booleanForProperty("escapeHTML", c );
        value = valueForProperty("value", c );
        valueWhenEmpty = valueForProperty("valueWhenEmpty", c );
        
        Object result = value;
	    if ( result != null )
        {
            if ( formatter != null )
            {
                try
                {
                    result = formatter.format( result );
                }
                catch ( IllegalArgumentException exc )
                {
                }
            }
            if ( dateformat != null )
            {
                try
                {
                    result = new NSTimestampFormatter( dateformat ).format( result );
                }
                catch ( IllegalArgumentException exc )
                {
                }
            }
            if ( numberformat != null )
            {
                try
                {
                    result = new NSNumberFormatter( numberformat ).format( result );
                }
                catch ( IllegalArgumentException exc )
                {
                }
            }
        }
	    if ( result == null )
	    {
            result = valueWhenEmpty;
            if ( result == null )
            {
                result = "nil";
            }
	    }
    	if ( escapeHTML )
	    {
    		aResponse.appendContentHTMLString( result.toString() );
	    }
	    else
	    {
    		aResponse.appendContentString( result.toString() );
		}
    }
}