|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| XHTMLLinkTypeRenderer | Line # 43 | 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.internal.renderer.xhtml.link; | |
| 21 | ||
| 22 | import org.xwiki.component.annotation.ComponentRole; | |
| 23 | import org.xwiki.rendering.listener.LinkListener; | |
| 24 | import org.xwiki.rendering.renderer.printer.XHTMLWikiPrinter; | |
| 25 | ||
| 26 | /** | |
| 27 | * Renders a type of link (mailto link, document link, URL, etc) in XHTML. Components implementing this | |
| 28 | * interface implement the rendering logic only for a single link type and must have a role hint value | |
| 29 | * equal to the {@link org.xwiki.rendering.listener.reference.ResourceType} name (eg "doc" for document link, "attach" | |
| 30 | * for attachment link, etc). | |
| 31 | * | |
| 32 | * Implementations must handle both cases when rendering a link: | |
| 33 | * <ul> | |
| 34 | * <li>when inside a wiki (ie when an implementation of {@link org.xwiki.rendering.wiki.WikiModel} is provided.</li> | |
| 35 | * <li>when outside of a wiki. In this case links to attachmets or documents are ignored and rendered as is as | |
| 36 | * direct HREF values. In other words only external links are meaningful.</li> | |
| 37 | * </ul> | |
| 38 | * | |
| 39 | * @version $Id$ | |
| 40 | * @since 2.5M2 | |
| 41 | */ | |
| 42 | @ComponentRole | |
| 43 | public interface XHTMLLinkTypeRenderer extends LinkListener | |
| 44 | { | |
| 45 | /** | |
| 46 | * @param printer the XHTML printer to use to output links as XHTML | |
| 47 | */ | |
| 48 | void setXHTMLWikiPrinter(XHTMLWikiPrinter printer); | |
| 49 | ||
| 50 | /** | |
| 51 | * @return the XHTML printer to use to output links as XHTML | |
| 52 | */ | |
| 53 | XHTMLWikiPrinter getXHTMLWikiPrinter(); | |
| 54 | ||
| 55 | /** | |
| 56 | * @param hasLabel true if the link to be rendered has a label specified or false otherwise. If no label has been | |
| 57 | * specified then it's up to the XHTML renderer implementation to generate a default label. | |
| 58 | */ | |
| 59 | void setHasLabel(boolean hasLabel); | |
| 60 | } | |
|
||||||||||||