| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| HTMLLikeMarkupLanguage |
|
| 1.5;1.5 |
| 1 | /* | |
| 2 | * $Source$ | |
| 3 | * $Revision$ | |
| 4 | * | |
| 5 | * Copyright (C) 2000 William Chesters | |
| 6 | * | |
| 7 | * Part of Melati (http://melati.org), a framework for the rapid | |
| 8 | * development of clean, maintainable web applications. | |
| 9 | * | |
| 10 | * Melati is free software; Permission is granted to copy, distribute | |
| 11 | * and/or modify this software under the terms either: | |
| 12 | * | |
| 13 | * a) the GNU General Public License as published by the Free Software | |
| 14 | * Foundation; either version 2 of the License, or (at your option) | |
| 15 | * any later version, | |
| 16 | * | |
| 17 | * or | |
| 18 | * | |
| 19 | * b) any version of the Melati Software License, as published | |
| 20 | * at http://melati.org | |
| 21 | * | |
| 22 | * You should have received a copy of the GNU General Public License and | |
| 23 | * the Melati Software License along with this program; | |
| 24 | * if not, write to the Free Software Foundation, Inc., | |
| 25 | * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the | |
| 26 | * GNU General Public License and visit http://melati.org to obtain the | |
| 27 | * Melati Software License. | |
| 28 | * | |
| 29 | * Feel free to contact the Developers of Melati (http://melati.org), | |
| 30 | * if you would like to work out a different arrangement than the options | |
| 31 | * outlined here. It is our intention to allow Melati to be used by as | |
| 32 | * wide an audience as possible. | |
| 33 | * | |
| 34 | * This program is distributed in the hope that it will be useful, | |
| 35 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 36 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 37 | * GNU General Public License for more details. | |
| 38 | * | |
| 39 | * Contact details for copyright holder: | |
| 40 | * | |
| 41 | * William Chesters <williamc@paneris.org> | |
| 42 | * http://paneris.org/~williamc | |
| 43 | * Obrechtstraat 114, 2517VX Den Haag, The Netherlands | |
| 44 | */ | |
| 45 | ||
| 46 | package org.melati.template; | |
| 47 | ||
| 48 | import java.io.IOException; | |
| 49 | import java.text.DateFormat; | |
| 50 | ||
| 51 | import org.melati.Melati; | |
| 52 | import org.melati.poem.Persistent; | |
| 53 | import org.melati.util.MelatiWriter; | |
| 54 | import org.melati.poem.PoemLocale; | |
| 55 | import org.melati.util.HTMLUtils; | |
| 56 | import org.melati.util.UTF8URLEncoder; | |
| 57 | ||
| 58 | /** | |
| 59 | * A Markup language with syntax similar to HTML. | |
| 60 | */ | |
| 61 | public abstract class HTMLLikeMarkupLanguage extends AbstractMarkupLanguage | |
| 62 | implements MarkupLanguage { | |
| 63 | ||
| 64 | /** | |
| 65 | * Constructor. | |
| 66 | */ | |
| 67 | public HTMLLikeMarkupLanguage(String name, Melati melati, | |
| 68 | TempletLoader templetLoader, | |
| 69 | PoemLocale locale) { | |
| 70 | 678 | super(name, melati, templetLoader, locale); |
| 71 | 678 | } |
| 72 | ||
| 73 | protected HTMLLikeMarkupLanguage(String name, HTMLLikeMarkupLanguage other) { | |
| 74 | 256 | super(name, other); |
| 75 | 256 | } |
| 76 | ||
| 77 | /** | |
| 78 | * Render, directly to the output stream, substituting entities for | |
| 79 | * high value ASCII characters and new line characters. | |
| 80 | * To avoid the unnecessary overhead of writing to a string and then writing | |
| 81 | * that string to the output stream we render directly to the output stream. | |
| 82 | */ | |
| 83 | public void render(String s, MelatiWriter writer) { | |
| 84 | try { | |
| 85 | 7223 | writer.write(HTMLUtils.entitied(s, true, melati.getEncoding(), false)); |
| 86 | 0 | } catch (IOException e) { |
| 87 | 0 | throw new TemplateIOException("Problem writing " + s, e); |
| 88 | 7223 | } |
| 89 | ||
| 90 | 7223 | } |
| 91 | ||
| 92 | /** | |
| 93 | * {@inheritDoc} | |
| 94 | * @see org.melati.template.AbstractMarkupLanguage#renderMarkup(java.lang.String, org.melati.util.MelatiWriter) | |
| 95 | */ | |
| 96 | public void renderMarkup(String s, MelatiWriter writer) { | |
| 97 | try { | |
| 98 | 5 | writer.write(HTMLUtils.entitied(s, false, melati.getEncoding(), true)); |
| 99 | 0 | } catch (IOException e) { |
| 100 | 0 | throw new TemplateIOException("Problem writing " + s, e); |
| 101 | 5 | } |
| 102 | 5 | } |
| 103 | ||
| 104 | /** | |
| 105 | * Escape a String. | |
| 106 | * | |
| 107 | * @param s the String to escape | |
| 108 | * @return the escaped String | |
| 109 | */ | |
| 110 | public String escaped(String s) { | |
| 111 | 430 | return HTMLUtils.jsEscaped(s); |
| 112 | } | |
| 113 | ||
| 114 | /** | |
| 115 | * Get the DisplayString of a <code>Persistent</code> and | |
| 116 | * escape that using the current locale and a MEDIUM DateFormat. | |
| 117 | * | |
| 118 | * See org/melati/admin/SelectionWindowSelection.wm | |
| 119 | * See org/melati/admin/Update.wm | |
| 120 | * @param o | |
| 121 | * @return the escaped DisplayString | |
| 122 | */ | |
| 123 | public String escaped(Persistent o) { | |
| 124 | 21 | return escaped(o.displayString(locale, DateFormat.MEDIUM)); |
| 125 | } | |
| 126 | ||
| 127 | /** | |
| 128 | * {@inheritDoc} | |
| 129 | * @see org.melati.template.MarkupLanguage#encoded(java.lang.String) | |
| 130 | */ | |
| 131 | public String encoded(String s) { | |
| 132 | 2796 | return UTF8URLEncoder.encode(s, melati.getEncoding()); |
| 133 | } | |
| 134 | /** | |
| 135 | * {@inheritDoc} | |
| 136 | * @see org.melati.template.MarkupLanguage#decoded(java.lang.String) | |
| 137 | */ | |
| 138 | public String decoded(String s) { | |
| 139 | 3 | return UTF8URLEncoder.decode(s, melati.getEncoding()); |
| 140 | } | |
| 141 | } | |
| 142 |