| Class | Line # | Actions | |||||
|---|---|---|---|---|---|---|---|
| LinkListener | 35 | 0 | - | 0 | 0 |
| 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.listener; | |
| 21 | ||
| 22 | import java.util.Map; | |
| 23 | ||
| 24 | import org.xwiki.filter.annotation.Default; | |
| 25 | import org.xwiki.rendering.listener.reference.ResourceReference; | |
| 26 | ||
| 27 | /** | |
| 28 | * Contains callback events for Links, called when a document has been parsed and when it needs to be modified or | |
| 29 | * rendered. | |
| 30 | * | |
| 31 | * @version $Id: 8ee1e835a02c274ed86ccae81909ce934aaed336 $ | |
| 32 | * @since 1.8RC3 | |
| 33 | * @see Listener | |
| 34 | */ | |
| 35 | public interface LinkListener | |
| 36 | { | |
| 37 | /** | |
| 38 | * Start of a link. | |
| 39 | * | |
| 40 | * @param reference the link reference | |
| 41 | * @param freestanding if true then the link is a free standing URI directly in the text | |
| 42 | * @param parameters a generic list of parameters. Example: style="background-color: blue" | |
| 43 | * @see ResourceReference | |
| 44 | * @since 2.5RC1 | |
| 45 | */ | |
| 46 | void beginLink(ResourceReference reference, boolean freestanding, @Default("") Map<String, String> parameters); | |
| 47 | ||
| 48 | /** | |
| 49 | * End of a link. | |
| 50 | * | |
| 51 | * @param reference the link reference | |
| 52 | * @param freestanding if true then the link is a free standing URI directly in the text | |
| 53 | * @param parameters a generic list of parameters. Example: style="background-color: blue" | |
| 54 | * @see ResourceReference | |
| 55 | * @since 2.5RC1 | |
| 56 | */ | |
| 57 | void endLink(ResourceReference reference, boolean freestanding, @Default("") Map<String, String> parameters); | |
| 58 | } |