com.atlassian.plugin.web.api

Interface WebFragment

All Known Subinterfaces:

WebItem, WebSection

All Known Implementing Classes:

AbstractWebFragment, WebItemImpl, WebSectionImpl

@PublicApi
public interface WebFragment

Represents an abstract UI element with a number of commonly used properties.

Attributes returned by getters will not be escaped yet for whatever context they are inserted in. In other words if are accessing Webfragments to be included in a HTML page, properties returned by getters should be appropriately HTML escaped.

Since:

v3.0.2

Method Summary

Methods

Modifier and Type	Method and Description
String	getCompleteKey()
String	getId()
String	getLabel()
Map<String,String>	getParams()
String	getStyleClass()
String	getTitle()
int	getWeight()

Method Detail

getCompleteKey

String getCompleteKey()

Returns:

the complete underlying web-fragment plugin key

getLabel

String getLabel()

Returns:

The label for the fragment

getTitle

String getTitle()

Returns:

The title (tooltip) for the fragment

getStyleClass

String getStyleClass()

Returns:

The style to apply to the fragment

getId

String getId()

Returns:

The unique id for the fragment.

getParams

@Nonnull
Map<String,String> getParams()

Returns:

untyped params of this fragment

getWeight

int getWeight()

Returns:

The weight for the fragment