com.atlassian.confluence.api.model.web

Class WebItemView

java.lang.Object

com.atlassian.confluence.api.model.web.WebItemView

public class WebItemView
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebItemView.Builder

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAccessKey()
Icon	getIcon()
java.lang.String	getId()
java.lang.String	getKey()
java.lang.String	getLabel()
java.lang.String	getLinkUrl()
java.util.Map<java.lang.String,java.lang.String>	getParams()
java.lang.String	getStyleClass()
java.lang.String	getTooltip()
java.lang.String	getUrlWithoutContextPath()
int	getWeight()

Methods inherited from class java.lang.Object

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

Method Detail

getLinkUrl

public java.lang.String getLinkUrl()

Returns:

a 'display' url for rendering a link to this WebItem within confluence. This could be either a relative URL that includes a context path, or an absolute URL.

getId

public java.lang.String getId()

getAccessKey

public java.lang.String getAccessKey()

getLabel

public java.lang.String getLabel()

getTooltip

public java.lang.String getTooltip()

getStyleClass

public java.lang.String getStyleClass()

getIcon

public Icon getIcon()

getWeight

public int getWeight()

getKey

public java.lang.String getKey()

getUrlWithoutContextPath

public java.lang.String getUrlWithoutContextPath()

Returns:

a URL to the webitem that does not include the context path

getParams

public java.util.Map<java.lang.String,java.lang.String> getParams()