| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| MathMLScriptElement |
|
| 1.0;1 |
| 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 subscript, superscript and subscript-superscript pair elements msub, | |
| 29 | * msup, and msubsup. | |
| 30 | * | |
| 31 | * | |
| 32 | */ | |
| 33 | public interface MathMLScriptElement extends MathMLPresentationElement { | |
| 34 | /** | |
| 35 | * A string representing the minimum amount to shift the baseline of the | |
| 36 | * subscript down, if specified; this is the element's subscriptshift | |
| 37 | * attribute. This must return null for an msup. | |
| 38 | * | |
| 39 | * @return value of the subscriptshift attribute. | |
| 40 | */ | |
| 41 | String getSubscriptshift(); | |
| 42 | ||
| 43 | /** | |
| 44 | * setter for the subscriptshift attribute. | |
| 45 | * | |
| 46 | * @param subscriptshift | |
| 47 | * new value for subscriptshift. | |
| 48 | * @see #getSubscriptshift() | |
| 49 | */ | |
| 50 | void setSubscriptshift(String subscriptshift); | |
| 51 | ||
| 52 | /** | |
| 53 | * A string representing the minimum amount to shift the baseline of the | |
| 54 | * superscript up, if specified; this is the element's superscriptshift | |
| 55 | * attribute. This must return null for a msub. | |
| 56 | * | |
| 57 | * @return value of the superscriptshift attribute. | |
| 58 | */ | |
| 59 | String getSuperscriptshift(); | |
| 60 | ||
| 61 | /** | |
| 62 | * setter for the superscriptshift attribute. | |
| 63 | * | |
| 64 | * @param superscriptshift | |
| 65 | * new value for superscriptshift. | |
| 66 | * @see #getSuperscriptshift() | |
| 67 | */ | |
| 68 | void setSuperscriptshift(String superscriptshift); | |
| 69 | ||
| 70 | /** | |
| 71 | * A MathMLElement representing the base of the script. This is the first | |
| 72 | * child of the element. | |
| 73 | * | |
| 74 | * @return value of the base attribute. | |
| 75 | */ | |
| 76 | MathMLElement getBase(); | |
| 77 | ||
| 78 | /** | |
| 79 | * setter for the base attribute. | |
| 80 | * | |
| 81 | * @param base | |
| 82 | * new value for base. | |
| 83 | * @see #getBase() | |
| 84 | */ | |
| 85 | void setBase(MathMLElement base); | |
| 86 | ||
| 87 | /** | |
| 88 | * A MathMLElement representing the subscript of the script. This is the | |
| 89 | * second child of a msub or msubsup; retrieval must return null for an | |
| 90 | * msup. | |
| 91 | * | |
| 92 | * @return value of the subscript attribute. | |
| 93 | */ | |
| 94 | MathMLElement getSubscript(); | |
| 95 | ||
| 96 | /** | |
| 97 | * setter for the subscript attribute. | |
| 98 | * | |
| 99 | * @param subscript | |
| 100 | * new value for subscript. | |
| 101 | * @see #getSubscript() | |
| 102 | * @throws DOMException | |
| 103 | * HIERARCHY_REQUEST_ERR: Raised when the element is a msup. | |
| 104 | */ | |
| 105 | void setSubscript(MathMLElement subscript); | |
| 106 | ||
| 107 | /** | |
| 108 | * A MathMLElement representing the superscript of the script. This is the | |
| 109 | * second child of a msup or the third child of a msubsup; retrieval must | |
| 110 | * return null for an msub. | |
| 111 | * | |
| 112 | * @return value of the superscript attribute. | |
| 113 | */ | |
| 114 | MathMLElement getSuperscript(); | |
| 115 | ||
| 116 | /** | |
| 117 | * setter for the superscript attribute. | |
| 118 | * | |
| 119 | * @param superscript | |
| 120 | * new value for superscript. | |
| 121 | * @see #getSuperscript() | |
| 122 | * @throws DOMException | |
| 123 | * HIERARCHY_REQUEST_ERR: Raised when the element is a msub. | |
| 124 | */ | |
| 125 | void setSuperscript(MathMLElement superscript); | |
| 126 | }; |