com.atlassian.confluence.api.model.web

Class WebItemView

java.lang.Object

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

@ExperimentalApi
public class WebItemView
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebItemView.Builder

Constructor Summary

Constructors

Constructor and Description
WebItemView(WebItemView.Builder builder)

Method Summary

Modifier and Type	Method and Description
static WebItemView.Builder	builder()
String	getAccessKey()
String	getCompleteKey()
Icon	getIcon()
String	getId()
String	getKey() Deprecated. since 5.10. Use getModuleKey()
String	getLabel()
String	getLinkUrl()
String	getModuleKey()
Map<String,String>	getParams()
String	getSection()
String	getStyleClass()
String	getTooltip()
String	getUrlWithoutContextPath()
int	getWeight()

Methods inherited from class java.lang.Object

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

Constructor Detail

WebItemView

public WebItemView(WebItemView.Builder builder)

Method Detail

getLinkUrl

public 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 String getId()

getAccessKey

public String getAccessKey()

getCompleteKey

public String getCompleteKey()

Since:

5.10

getSection

public String getSection()

getLabel

public String getLabel()

getTooltip

public String getTooltip()

getStyleClass

public String getStyleClass()

getIcon

public Icon getIcon()

getWeight

public int getWeight()

getKey

@Deprecated
public String getKey()

Deprecated. since 5.10. Use getModuleKey()

getModuleKey

public String getModuleKey()

getUrlWithoutContextPath

public String getUrlWithoutContextPath()

Returns:

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

getParams

public Map<String,String> getParams()

builder

public static WebItemView.Builder builder()