de.tuberlin.cs.flp.jspwiki.tags


Class PageReferredByTag

com.ecyrd.jspwiki.tags.WikiTagBase
    inheritde.tuberlin.cs.flp.jspwiki.tags.PageReferredByTag

public class PageReferredByTag
Namespace: tags


<wiki:PageReferredBy page='...'>
    ...
</wiki:PageReferredBy>

Implements a JSP-tag named "<wiki:PageReferredBy>" which includes its body into the page if this page is referred from the page given by parameter page. (I.e., if 'page' contains a link to this page.)

Authors:
Jens Gulden


Attribute Summary
protected String  m_pageName
The name of the page which is tested whether it refers to the current page.  

Method Summary
public final int  doWikiStartTag()
Decides whether to include the body part or not. The body part is included if the page named by getPage() includes a link to the current page. Known bug: if this page's name contains special chars (e.g. German umlauts) an existing reference from the referring page may not be found.  
public String   getPage()
Returns the page name.  
public void  setPage(String page)
Sets the page name.  

Tagged Values
static false
documentation#author Jens Gulden

Attribute Detail

m_pageName

protected String m_pageName

Multiplicity: 1..1
Ordering: unspecified


The name of the page which is tested whether it refers to the current page.
Method Detail

doWikiStartTag

public final int doWikiStartTag()


Decides whether to include the body part or not. The body part is included if the page named by getPage() includes a link to the current page. Known bug: if this page's name contains special chars (e.g. German umlauts) an existing reference from the referring page may not be found.
Method Tagged Values
documentation#throws IOException if an i/o error occurs

Returns:
evaluation result code
Exceptions:
IOException if an i/o error occurs


getPage

public String getPage()


Returns the page name.
Returns:


setPage

public void setPage(String page)


Sets the page name.
Parameters:
page - The page name.

previous   TOC   next

Generated with Poseidon for UMLTM.
Poseidon is a registered trademark of Gentleware AG in the USA and other countries. Copyright 2003-2006 Gentleware AG, Ludwigstr. 12, 20357 Hamburg, Germany. All Rights Reserved.
UML is a trademark or registered trademark of Object Management Group, Inc. in the U.S. and other countries.