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 table or matrix row element mtr.
29   * 
30   * 
31   */
32  public interface MathMLTableRowElement extends MathMLPresentationElement {
33      /**
34       * A string representing an override of the row alignment specified in the
35       * containing mtable. Allowed values are top, bottom, center, baseline,
36       * and axis.
37       * 
38       * @return value of the rowalign attribute.
39       */
40      String getRowalign();
41  
42      /**
43       * setter for the rowalign attribute.
44       * 
45       * @param rowalign
46       *            new value for rowalign.
47       * @see #getRowalign()
48       */
49      void setRowalign(String rowalign);
50  
51      /**
52       * A string representing an override of the column alignment specified in
53       * the containing mtable. Allowed values are left, center, and right.
54       * 
55       * @return value of the columnalign attribute.
56       */
57      String getColumnalign();
58  
59      /**
60       * setter for the columnalign attribute.
61       * 
62       * @param columnalign
63       *            new value for columnalign.
64       * @see #getColumnalign()
65       */
66      void setColumnalign(String columnalign);
67  
68      /**
69       * A string specifying how the alignment groups within the cells of each
70       * row are to be aligned with the corresponding items above or below them
71       * in the same column. The string consists of a sequence of braced group
72       * alignment lists. Each group alignment list is a space-separated
73       * sequence, each of which can have the following values: left, right,
74       * center, or decimalpoint.
75       * 
76       * @return value of the groupalign attribute.
77       */
78      String getGroupalign();
79  
80      /**
81       * setter for the groupalign attribute.
82       * 
83       * @param groupalign
84       *            new value for groupalign.
85       * @see #getGroupalign()
86       */
87      void setGroupalign(String groupalign);
88  
89      /**
90       * A MathMLNodeList consisting of the cells of the row. Note that this
91       * does not include the label if this is a MathMLLabeledRowElement!
92       * 
93       * @return value of the cells attribute.
94       */
95      MathMLNodeList getCells();
96  
97      /**
98       * A convenience method to insert a new (empty) cell in the row.
99       * 
100      * @param index
101      *            Index of the cell before which the new cell is to be
102      *            inserted, where the first cell is numbered 0. If index is
103      *            equal to the current number of cells, the new cell is
104      *            appended as the last cell of the row. Note that the index
105      *            will differ from the index of the corresponding Node in the
106      *            collection returned by Node::childNodes if this is a
107      *            MathMLLabeledRowElement!
108      * @return Returns the MathMLTableCellElement representing the mtd element
109      *         being inserted.
110      * @throws DOMException
111      *             INDEX_SIZE_ERR: Raised if index is greater than the current
112      *             number of cells of this mtr element.
113      */
114     MathMLTableCellElement insertEmptyCell(int index) throws DOMException;
115 
116     /**
117      * A convenience method to insert a new cell in the row.
118      * 
119      * @param newCell
120      *            A MathMLTableCellElement representing the new cell (mtd
121      *            element) to be inserted.
122      * @param index
123      *            Index of the cell before which the new cell is to be
124      *            inserted, where the first cell is numbered 0. If index
125      *            equals the current number of cells, the new cell is appended
126      *            as the last cell of the row. Note that the index will differ
127      *            from the index of the corresponding Node in Node::childNodes
128      *            if this is a MathMLLabeledRowElement!
129      * @return The MathMLTableCellElement representing the mtd element being
130      *         inserted.
131      * @throws DOMException
132      *             INDEX_SIZE_ERR: Raised if index is greater than the current
133      *             number of cells of this mtr element.
134      */
135     MathMLTableCellElement insertCell(MathMLTableCellElement newCell,
136             int index) throws DOMException;
137 
138     /**
139      * A convenience method to set the value of a cell in the row to newCell.
140      * If index is equal to the current number of cells, newCell is appended
141      * as the last cell in the row.
142      * 
143      * @param newCell
144      *            A MathMLTableCellElement representing the cell (mtd element)
145      *            that is to be inserted.
146      * @param index
147      *            Index of the cell that is to be replaced by the new cell,
148      *            where the first cell is numbered 0. Note that the index will
149      *            differ from the index of the corresponding Node in the
150      *            collection returned by Node::childNodes if this is a
151      *            MathMLLabeledRowElement!
152      * @return The MathMLTableCellElement child of this MathMLTableRowElement
153      *         representing the new mtd element.
154      */
155     MathMLTableCellElement setCell(MathMLTableCellElement newCell, int index);
156 
157     /**
158      * A convenience method to delete a cell in the row.
159      * 
160      * @param index
161      *            Index of cell to be deleted. Note that the count will differ
162      *            from the index-th child node if this is a
163      *            MathMLLabeledRowElement!
164      */
165     void deleteCell(int index);
166 };