 | Report generated by Clover Code Coverage v3.1.4 Mon Mar 12 2012 18:03:37 CET. |
Clover: Open Source License registered to XWiki. |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| IWemListenerSemantic | Line # 31 | 0 | - | 0 | 0 | - |
-1.0
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| No Tests | |||
| 1 | /* | |
| 2 | * See the NOTICE file distributed with this work for additional | |
| 3 | * information regarding copyright ownership. | |
| 4 | * | |
| 5 | * This is free software; you can redistribute it and/or modify it | |
| 6 | * under the terms of the GNU Lesser General Public License as | |
| 7 | * published by the Free Software Foundation; either version 2.1 of | |
| 8 | * the License, or (at your option) any later version. | |
| 9 | * | |
| 10 | * This software is distributed in the hope that it will be useful, | |
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 | * Lesser General Public License for more details. | |
| 14 | * | |
| 15 | * You should have received a copy of the GNU Lesser General Public | |
| 16 | * License along with this software; if not, write to the Free | |
| 17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
| 18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
| 19 | */ | |
| 20 | package org.xwiki.rendering.wikimodel; | |
| 21 | ||
| 22 | /** | |
| 23 | * This listener is used to notify about semantic elements defined in the | |
| 24 | * document. Possible semantic elements are inline and block properties. Each | |
| 25 | * block property can have a document or a simple paragraph as its value. Each | |
| 26 | * inline element contains only formatted inline elements. | |
| 27 | * | |
| 28 | * @version $Id: 177f363a08e881d7bf677e38d04e7db4c69199ef $ | |
| 29 | * @since 4.0M1 | |
| 30 | */ | |
| 31 | public interface IWemListenerSemantic | |
| 32 | { | |
| 33 | /** | |
| 34 | * This method is called to notify about the beginning of a new property | |
| 35 | * found in the parsed document. | |
| 36 | * | |
| 37 | * @param propertyUri the URI of the semantic block property found in the | |
| 38 | * document | |
| 39 | * @param doc this flag is <code>true</code> if the found property contains | |
| 40 | * a whole document; if this flag is <code>false</code> then expected | |
| 41 | * property value contains a paragraph | |
| 42 | */ | |
| 43 | void beginPropertyBlock(String propertyUri, boolean doc); | |
| 44 | ||
| 45 | /** | |
| 46 | * This method is called to notify about the beginning of a new inline | |
| 47 | * property found in the text of the parsed document. | |
| 48 | * | |
| 49 | * @param propertyUri the URI of the semantic inline property found in the | |
| 50 | * document | |
| 51 | */ | |
| 52 | void beginPropertyInline(String propertyUri); | |
| 53 | ||
| 54 | /** | |
| 55 | * This method is called to notify about the end of a block property found | |
| 56 | * in the parsed document. | |
| 57 | * | |
| 58 | * @param propertyUri the URI of the semantic block property found in the | |
| 59 | * document | |
| 60 | * @param doc this flag is <code>true</code> if the found property contains | |
| 61 | * a whole document; otherwise (if this flag is <code>false</code>) | |
| 62 | * the value of the property is a simple paragraph | |
| 63 | */ | |
| 64 | void endPropertyBlock(String propertyUri, boolean doc); | |
| 65 | ||
| 66 | /** | |
| 67 | * This method is called to notify about the end of an inline property found | |
| 68 | * in the text of the parsed document. | |
| 69 | * | |
| 70 | * @param propertyUri the URI of the semantic inline property found in the | |
| 71 | * document | |
| 72 | */ | |
| 73 | void endPropertyInline(String propertyUri); | |
| 74 | } | |
|
||||||||||||