View Javadoc

1   /*
2    * Copyright 2007 - 2007 JEuclid, http://jeuclid.sf.net
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.w3c.dom.mathml;
17  
18  import org.w3c.dom.DOMException;
19  
20  /*
21   * Please note: This file was automatically generated from the source of the
22   * MathML specification. Do not edit it. If there are errors or missing
23   * elements, please correct the stylesheet instead.
24   */
25  
26  /**
27   * This interface extends the MathMLPresentationElement interface for the
28   * MathML underscript, overscript and overscript-underscript pair elements
29   * munder, mover and munderover.
30   * 
31   * 
32   */
33  public interface MathMLUnderOverElement extends MathMLPresentationElement {
34      /**
35       * Either true or false if present; a string controlling whether
36       * underscript is drawn as an accent or as a limit, if specified; this is
37       * the element's accentunder attribute. This must return null for an
38       * mover.
39       * 
40       * @return value of the accentunder attribute.
41       */
42      String getAccentunder();
43  
44      /**
45       * setter for the accentunder attribute.
46       * 
47       * @param accentunder
48       *            new value for accentunder.
49       * @see #getAccentunder()
50       */
51      void setAccentunder(String accentunder);
52  
53      /**
54       * Either true or false if present; a string controlling whether
55       * overscript is drawn as an accent or as a limit, if specified; this is
56       * the element's accent attribute. This must return null for an munder.
57       * 
58       * @return value of the accent attribute.
59       */
60      String getAccent();
61  
62      /**
63       * setter for the accent attribute.
64       * 
65       * @param accent
66       *            new value for accent.
67       * @see #getAccent()
68       */
69      void setAccent(String accent);
70  
71      /**
72       * A MathMLElement representing the base of the script. This is the first
73       * child of the element.
74       * 
75       * @return value of the base attribute.
76       */
77      MathMLElement getBase();
78  
79      /**
80       * setter for the base attribute.
81       * 
82       * @param base
83       *            new value for base.
84       * @see #getBase()
85       */
86      void setBase(MathMLElement base);
87  
88      /**
89       * A MathMLElement representing the underscript of the script. This is the
90       * second child of a munder or munderover; retrieval must return null for
91       * an mover.
92       * 
93       * @return value of the underscript attribute.
94       */
95      MathMLElement getUnderscript();
96  
97      /**
98       * setter for the underscript attribute.
99       * 
100      * @param underscript
101      *            new value for underscript.
102      * @see #getUnderscript()
103      * @throws DOMException
104      *             HIERARCHY_REQUEST_ERR: Raised when the element is a mover.
105      */
106     void setUnderscript(MathMLElement underscript);
107 
108     /**
109      * A MathMLElement representing the overscript of the script. This is the
110      * second child of a mover or the third child of a munderover; retrieval
111      * must return null for an munder.
112      * 
113      * @return value of the overscript attribute.
114      */
115     MathMLElement getOverscript();
116 
117     /**
118      * setter for the overscript attribute.
119      * 
120      * @param overscript
121      *            new value for overscript.
122      * @see #getOverscript()
123      * @throws DOMException
124      *             HIERARCHY_REQUEST_ERR: Raised when the element is a munder.
125      */
126     void setOverscript(MathMLElement overscript);
127 };