01: /*
02: * Help.java
03: *
04: * Version: $Revision: 1.5 $
05: *
06: * Date: $Date: 2006/03/13 17:19:39 $
07: *
08: * Copyright (c) 2002-2005, Hewlett-Packard Company and Massachusetts
09: * Institute of Technology. All rights reserved.
10: *
11: * Redistribution and use in source and binary forms, with or without
12: * modification, are permitted provided that the following conditions are
13: * met:
14: *
15: * - Redistributions of source code must retain the above copyright
16: * notice, this list of conditions and the following disclaimer.
17: *
18: * - Redistributions in binary form must reproduce the above copyright
19: * notice, this list of conditions and the following disclaimer in the
20: * documentation and/or other materials provided with the distribution.
21: *
22: * - Neither the name of the Hewlett-Packard Company nor the name of the
23: * Massachusetts Institute of Technology nor the names of their
24: * contributors may be used to endorse or promote products derived from
25: * this software without specific prior written permission.
26: *
27: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28: * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
30: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31: * HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
32: * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
33: * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
34: * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
35: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
36: * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
37: * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
38: * DAMAGE.
39: */
40:
41: package org.dspace.app.xmlui.wing.element;
42:
43: import org.dspace.app.xmlui.wing.WingContext;
44: import org.dspace.app.xmlui.wing.WingException;
45: import org.xml.sax.ContentHandler;
46: import org.xml.sax.SAXException;
47: import org.xml.sax.ext.LexicalHandler;
48: import org.xml.sax.helpers.NamespaceSupport;
49:
50: /**
51: * This class represents help instructions for a single field.
52: *
53: * @author Scott Phillips
54: */
55: public class Help extends TextContainer implements StructuralElement {
56: /** The name of the help element */
57: public static final String E_HELP = "help";
58:
59: /**
60: * Construct a new field help.
61: *
62: * @param context
63: * (Required) The context this element is contained in
64: */
65: protected Help(WingContext context) throws WingException {
66: super (context);
67: }
68:
69: /**
70: * Translate this element and all contained elements into SAX events. The
71: * events should be routed to the contentHandler found in the WingContext.
72: *
73: * @param contentHandler
74: * (Required) The registered contentHandler where SAX events
75: * should be routed too.
76: * @param lexicalHandler
77: * (Required) The registered lexicalHandler where lexical
78: * events (such as CDATA, DTD, etc) should be routed too.
79: * @param namespaces
80: * (Required) SAX Helper class to keep track of namespaces able
81: * to determine the correct prefix for a given namespace URI.
82: */
83:
84: public void toSAX(ContentHandler contentHandler,
85: LexicalHandler lexicalHandler, NamespaceSupport namespaces)
86: throws SAXException {
87: startElement(contentHandler, namespaces, E_HELP, null);
88: super .toSAX(contentHandler, lexicalHandler, namespaces);
89: endElement(contentHandler, namespaces, E_HELP);
90: }
91:
92: /**
93: * dispose
94: */
95: public void dispose() {
96: super.dispose();
97: }
98:
99: }
|