001: //** Copyright Statement ***************************************************
002: //The Salmon Open Framework for Internet Applications (SOFIA)
003: // Copyright (C) 1999 - 2002, Salmon LLC
004: //
005: // This program is free software; you can redistribute it and/or
006: // modify it under the terms of the GNU General Public License version 2
007: // as published by the Free Software Foundation;
008: //
009: // This program is distributed in the hope that it will be useful,
010: // but WITHOUT ANY WARRANTY; without even the implied warranty of
011: // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
012: // GNU General Public License for more details.
013: //
014: // You should have received a copy of the GNU General Public License
015: // along with this program; if not, write to the Free Software
016: // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
017: //
018: // For more information please visit http://www.salmonllc.com
019: //** End Copyright Statement ***************************************************
020: package com.salmonllc.jsp;
021:
022: /////////////////////////
023: //$Archive: /JADE/SourceCode/com/salmonllc/jsp/TagWriter.java $
024: //$Author: Dan $
025: //$Revision: 15 $
026: //$Modtime: 10/30/02 2:38p $
027: /////////////////////////
028:
029: import java.io.*;
030: import javax.servlet.jsp.*;
031:
032: /**
033: * This class is used in custom tag component's generateHtml method. For complex tags, the generateHtml method in the correspnding component is responsible for wrapping the output in the appropriate DreamWeaver html MMBeginLock and MMEndLock tags when the JSP is being rendered in Dreamweaver.
034: * This class facilitates this by providing methods that will wrap the tags (dreamWeaverConv). It also provides state information that indicates whether or not DreamWeaver tags or regular JSP tags should be rendered at a given time.
035: * A JspComponent need only call the print method in this object to write out its generated Html and this object will do the rest.
036: */
037: public class TagWriter {
038: public static final int TYPE_BEGIN_TAG = 0;
039: public static final int TYPE_END_TAG = 1;
040: public static final int TYPE_CONTENT = 2;
041: public static final int TYPE_INSERTED_CONTENT = 3;
042:
043: boolean _dreamWeaverConv = false;
044: String _prefix;
045: String _tagName;
046: String _tagStart;
047: String _tagEnd;
048: JspWriter _writer;
049:
050: public TagWriter() {
051: super ();
052: _dreamWeaverConv = false;
053: }
054:
055: public TagWriter(String prefix, String tagName, String startTag,
056: String endTag) {
057: super ();
058: _prefix = prefix;
059: _tagName = tagName;
060: _tagStart = startTag;
061: _tagEnd = endTag;
062: _dreamWeaverConv = true;
063: }
064:
065: /**
066: * This method will wrap an Html Tag in a Dreamweaver tag.
067: * @param prefix The tag's prefix
068: * @param name The tag's name
069: * @param orig The original jsp that described the custom tag
070: * @param conv The converted Html to render the content
071: */
072: public static String dreamWeaverConv(String prefix, String tagName,
073: String orig, String conv) {
074:
075: StringBuffer work = new StringBuffer(
076: "<MM:BeginLock translatorClass=\"fw\" type=\"");
077: work.append(prefix);
078: if (prefix != null && !prefix.equals(""))
079: work.append(":");
080: work.append(tagName);
081: work.append("\" orig=\"");
082: urlEncode(orig, work);
083: work.append("\">");
084: work.append(conv);
085: work.append("<MM:EndLock>");
086: return work.toString();
087: }
088:
089: /**
090: * Returns true if the writer is doing Dreamweaver conversion and false if it is regular Html.
091: */
092: public boolean getDreamWeaverConv() {
093: return _dreamWeaverConv;
094: }
095:
096: /**
097: * This method will print the content of the text exactly as passed
098: * @param text java.lang.String The text to output
099: */
100:
101: public void print(String text) throws IOException {
102: _writer.print(text);
103: }
104:
105: /**
106: * This method will insert content into the page based on the type of content and current mode
107: * @param text java.lang.String The text to output
108: * @param type the type of content to render. Valid Values are <BR>
109: * TYPE_BEGIN_TAG: This content is replacing an opening tag<BR>
110: * TYPE_END_TAG: This content is replacing a closing tag<BR>
111: * TYPE_CONTENT: This content is replaing the content in the tag<BR>
112: * TYPE_INSERTED_CONTENT: This content is entirely new and is not replacing any specific part of the JSP Tag that spawned the request.replaing the content in the tag<BR>
113: */
114: public void print(String text, int type) throws IOException {
115: if (!_dreamWeaverConv || type == TYPE_CONTENT)
116: _writer.print(text);
117: else if (type == TYPE_INSERTED_CONTENT) {
118: _writer.print(dreamWeaverConv(_prefix, _tagName, "", text));
119: } else {
120: String orig = _tagStart;
121: String prefix = _prefix;
122: if (type == TYPE_END_TAG) {
123: orig = _tagEnd;
124: prefix = "/" + prefix;
125: }
126: _writer
127: .print(dreamWeaverConv(prefix, _tagName, orig, text));
128: }
129: }
130:
131: /**
132: * This method will print a Blank Line
133: */
134: public void println() throws IOException {
135: _writer.println();
136: }
137:
138: /**
139: * This method will print the content of the text exactly as passed
140: * @param text java.lang.String The text to output
141: */
142: public void println(String text) throws IOException {
143: _writer.println(text);
144: }
145:
146: /**
147: * Sets the JSP Writer that the tag writer will write it's output too
148: */
149: public void setWriter(JspWriter w) {
150: _writer = w;
151: }
152:
153: /**
154: * This method will remove illegal characters for strings and append the results to a string buffer.
155: */
156: public static void urlEncode(String s, StringBuffer b) {
157: if (s == null)
158: return;
159:
160: for (int i = 0; i < s.length(); i++) {
161: char c = s.charAt(i);
162: if (c == '"')
163: b.append("%22");
164: else if (c == '<')
165: b.append("%3C");
166: else if (c == '>')
167: b.append("%3E");
168: else if (c == '%')
169: b.append("%25");
170: else
171: b.append(c);
172: }
173:
174: }
175: }
|