Module com.semanticcms.core.servlet

Package com.semanticcms.core.servlet

Class Link

java.lang.Object

com.semanticcms.core.servlet.Link

public class Link
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Link.Body
static interface	Link.PageContextBody

Constructor Summary

Constructors

Constructor	Description
Link()	Creates a new link in the current page context.
Link(String page)	Creates a new link in the current page context.
Link(String book, String page)	Creates a new link in the current page context.
Link(String book, String page, String element)	Creates a new link in the current page context.
Link(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response)
Link(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response, String page)
Link(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response, String book, String page)
Link(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response, String book, String page, String element)

Method Summary

Modifier and Type	Method	Description
Link	absolute(boolean absolute)
Link	allowGeneratedElement(boolean allowGeneratedElement)
Link	anchor(String anchor)
Link	book(String book)
Link	canonical(boolean canonical)
Link	clazz(Object clazz)
Link	element(String element)
void	invoke()
void	invoke(Link.Body body)	Also establishes a new PageContext.
void	invoke(Link.PageContextBody body)
Link	page(String page)
Link	params(URIParameters params)
Link	small(boolean small)	When false, the default, will generate a <a> tag around the entire body.
Link	view(String view)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Link

public Link(ServletContext servletContext,
 HttpServletRequest request,
 HttpServletResponse response)

Link

public Link(ServletContext servletContext,
 HttpServletRequest request,
 HttpServletResponse response,
 String page)

Link

public Link(ServletContext servletContext,
 HttpServletRequest request,
 HttpServletResponse response,
 String book,
 String page)

Link

public Link(ServletContext servletContext,
 HttpServletRequest request,
 HttpServletResponse response,
 String book,
 String page,
 String element)

Link

public Link()

Creates a new link in the current page context.

See Also:

• PageContext

Link

public Link(String page)

Creates a new link in the current page context.

See Also:

• PageContext

Link

public Link(String book,
 String page)

Creates a new link in the current page context.

See Also:

• PageContext

Link

public Link(String book,
 String page,
 String element)

Creates a new link in the current page context.

See Also:

• PageContext

Method Details

book

public Link book(String book)

page

public Link page(String page)

element

public Link element(String element)

allowGeneratedElement

public Link allowGeneratedElement(boolean allowGeneratedElement)

anchor

public Link anchor(String anchor)

view

public Link view(String view)

small

public Link small(boolean small)

When false, the default, will generate a <a> tag around the entire body. Otherwise, will generate a <span> instead, with a small link added to the end of the body.

Use of a small link can be helpful for usability, such as when the body is a piece of information intended for quick copy/paste by the user.

params

public Link params(URIParameters params)

absolute

public Link absolute(boolean absolute)

canonical

public Link canonical(boolean canonical)

clazz

public Link clazz(Object clazz)

invoke

public void invoke(Link.Body body)
            throws ServletException,
IOException,
SkipPageException

Also establishes a new PageContext.

Throws:

ServletException

IOException

SkipPageException

See Also:

• PageContext

invoke

public void invoke()
            throws ServletException,
IOException,
SkipPageException

Throws:

ServletException

IOException

SkipPageException

See Also:

• invoke(com.semanticcms.core.servlet.Link.Body)

invoke

public void invoke(Link.PageContextBody body)
            throws ServletException,
IOException,
SkipPageException

Throws:

ServletException

IOException

SkipPageException

See Also:

• invoke(com.semanticcms.core.servlet.Link.Body)