A B C D G H I L N O P R S T U W

A

AbstractCompositeCondition - Class in com.atlassian.plugin.web.conditions

AbstractCompositeCondition(Condition...) - Constructor for class com.atlassian.plugin.web.conditions.AbstractCompositeCondition

AbstractWebFragment - Class in com.atlassian.plugin.web.api.model

AbstractWebFragment(String, String, String, String, String, Map<String, String>, int) - Constructor for class com.atlassian.plugin.web.api.model.AbstractWebFragment

accessKey(String) - Method in class com.atlassian.plugin.web.api.model.WebFragmentBuilder.WebItemBuilder

addCondition(T) - Method in interface com.atlassian.plugin.web.baseconditions.CompositeCondition

addCondition(Condition) - Method in class com.atlassian.plugin.web.conditions.AbstractCompositeCondition

addParam(String, String) - Method in class com.atlassian.plugin.web.api.model.WebFragmentBuilder

AlwaysDisplayCondition - Class in com.atlassian.plugin.web.conditions

Always show a web link.

AlwaysDisplayCondition() - Constructor for class com.atlassian.plugin.web.conditions.AlwaysDisplayCondition

AndCompositeCondition - Class in com.atlassian.plugin.web.conditions

AndCompositeCondition() - Constructor for class com.atlassian.plugin.web.conditions.AndCompositeCondition

AndCompositeCondition(Condition...) - Constructor for class com.atlassian.plugin.web.conditions.AndCompositeCondition

B

BaseCondition - Interface in com.atlassian.plugin.web.baseconditions

Marker interface for conditions

build() - Method in class com.atlassian.plugin.web.api.model.WebFragmentBuilder.WebItemBuilder

build() - Method in class com.atlassian.plugin.web.api.model.WebFragmentBuilder.WebSectionBuilder

C

com.atlassian.plugin.web - package com.atlassian.plugin.web

com.atlassian.plugin.web.api - package com.atlassian.plugin.web.api

com.atlassian.plugin.web.api.model - package com.atlassian.plugin.web.api.model

com.atlassian.plugin.web.api.provider - package com.atlassian.plugin.web.api.provider

com.atlassian.plugin.web.baseconditions - package com.atlassian.plugin.web.baseconditions

com.atlassian.plugin.web.conditions - package com.atlassian.plugin.web.conditions

com.atlassian.plugin.web.descriptors - package com.atlassian.plugin.web.descriptors

com.atlassian.plugin.web.model - package com.atlassian.plugin.web.model

compare(WebFragment, WebFragment) - Method in class com.atlassian.plugin.web.api.model.WeightedComparator

CompositeCondition<T extends BaseCondition> - Interface in com.atlassian.plugin.web.baseconditions

Interface for composite conditions

Condition - Interface in com.atlassian.plugin.web

Decides whether a web section or web item should be displayed

ConditionalDescriptor - Interface in com.atlassian.plugin.web.descriptors

A simple interface implemented by any descriptors that support display conditions.

ConditionLoadingException - Exception in com.atlassian.plugin.web.conditions

ConditionLoadingException() - Constructor for exception com.atlassian.plugin.web.conditions.ConditionLoadingException

ConditionLoadingException(String) - Constructor for exception com.atlassian.plugin.web.conditions.ConditionLoadingException

ConditionLoadingException(String, Throwable) - Constructor for exception com.atlassian.plugin.web.conditions.ConditionLoadingException

ConditionLoadingException(Throwable) - Constructor for exception com.atlassian.plugin.web.conditions.ConditionLoadingException

conditions - Variable in class com.atlassian.plugin.web.conditions.AbstractCompositeCondition

ContextAware - Interface in com.atlassian.plugin.web.descriptors

Makes a plugin module aware of its Velocity context.

ContextProvider - Interface in com.atlassian.plugin.web

Main purpose of this is to add additional context entries for the web fragment and make it available within the XML

D

DynamicWebInterfaceManager - Interface in com.atlassian.plugin.web.api

A dynamic web interface manager extends the existing WebInterfaceManager interface with methods to retrieve items and sections that are created by WebItemProviders and WebSectionProviders as well as static items and sections returned by the existing WebInterfaceManager.

G

get(String) - Method in interface com.atlassian.plugin.web.model.WebParam

Deprecated.

getAccessKey() - Method in class com.atlassian.plugin.web.api.model.WebItemImpl

getAccessKey() - Method in interface com.atlassian.plugin.web.api.WebItem

getAccessKey(Map<String, Object>) - Method in interface com.atlassian.plugin.web.model.WebLink

Deprecated.

getCompleteKey() - Method in class com.atlassian.plugin.web.api.model.AbstractWebFragment

getCompleteKey() - Method in interface com.atlassian.plugin.web.api.WebFragment

getCondition() - Method in interface com.atlassian.plugin.web.descriptors.ConditionalDescriptor

getCondition() - Method in interface com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor

getContextMap(Map<String, Object>) - Method in interface com.atlassian.plugin.web.ContextProvider

Gets the additional context map to make available for the web fragment

getContextProvider() - Method in interface com.atlassian.plugin.web.descriptors.ContextAware

Returns the ContextProvider that augments the context used to render a web module.

getDescriptor() - Method in interface com.atlassian.plugin.web.model.WebLink

Deprecated.

getDescriptor() - Method in interface com.atlassian.plugin.web.model.WebParam

Deprecated.

getDisplayableItems(String, Map<String, Object>) - Method in interface com.atlassian.plugin.web.WebInterfaceManager

Deprecated.

as of 3.0.2 use DynamicWebInterfaceManager.getDisplayableWebItems(String, java.util.Map)

getDisplayableLabel(HttpServletRequest, Map<String, Object>) - Method in interface com.atlassian.plugin.web.model.WebLabel

Deprecated.

getDisplayableSections(String, Map<String, Object>) - Method in interface com.atlassian.plugin.web.WebInterfaceManager

Deprecated.

as of 3.0.2 use DynamicWebInterfaceManager.getDisplayableWebSections(String, java.util.Map)

getDisplayableUrl(HttpServletRequest, Map<String, Object>) - Method in interface com.atlassian.plugin.web.model.WebLink

Deprecated.

getDisplayableWebItems(String, Map<String, Object>) - Method in interface com.atlassian.plugin.web.api.DynamicWebInterfaceManager

Same as DynamicWebInterfaceManager.getWebItems(String, java.util.Map) but apply conditions for static web-items using the context provided.

getDisplayableWebPanelDescriptors(String, Map<String, Object>) - Method in interface com.atlassian.plugin.web.WebInterfaceManager

getDisplayableWebPanels(String, Map<String, Object>) - Method in interface com.atlassian.plugin.web.WebInterfaceManager

getDisplayableWebSections(String, Map<String, Object>) - Method in interface com.atlassian.plugin.web.api.DynamicWebInterfaceManager

Same as DynamicWebInterfaceManager.getWebSections(String, java.util.Map) but apply conditions for static web-sections using the context provided.

getHeight() - Method in interface com.atlassian.plugin.web.model.WebIcon

Deprecated.

getHtml(Map<String, Object>) - Method in interface com.atlassian.plugin.web.model.WebPanel

Returns the HTML that will be placed in the host application's page.

getI18nValue(String, List<?>, Map<String, Object>) - Method in interface com.atlassian.plugin.web.WebFragmentHelper

Look up a message key in the application

getIcon() - Method in interface com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor

getId() - Method in class com.atlassian.plugin.web.api.model.AbstractWebFragment

getId() - Method in interface com.atlassian.plugin.web.api.WebFragment

getId() - Method in interface com.atlassian.plugin.web.model.WebLink

Deprecated.

getItems(Map<String, Object>) - Method in interface com.atlassian.plugin.web.api.provider.WebItemProvider

Returns a list of web-items for a given context.

getItems(String) - Method in interface com.atlassian.plugin.web.WebInterfaceManager

Deprecated.

as of 3.0.2 use DynamicWebInterfaceManager.getWebItems(String, java.util.Map)

getKey() - Method in interface com.atlassian.plugin.web.model.WebLabel

Deprecated.

getLabel() - Method in class com.atlassian.plugin.web.api.model.AbstractWebFragment

getLabel() - Method in interface com.atlassian.plugin.web.api.WebFragment

getLink() - Method in interface com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor

getLocation() - Method in class com.atlassian.plugin.web.api.model.WebSectionImpl

getLocation() - Method in interface com.atlassian.plugin.web.api.WebSection

getLocation() - Method in interface com.atlassian.plugin.web.descriptors.WebPanelModuleDescriptor

Returns the location in the host application where the web panel should be embedded.

getLocation() - Method in interface com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor

getNoKeyValue() - Method in interface com.atlassian.plugin.web.model.WebLabel

Deprecated.

getParams() - Method in class com.atlassian.plugin.web.api.model.AbstractWebFragment

getParams() - Method in interface com.atlassian.plugin.web.api.WebFragment

getParams() - Method in interface com.atlassian.plugin.web.model.WebParam

Deprecated.

getRenderedParam(String, Map<String, Object>) - Method in interface com.atlassian.plugin.web.model.WebParam

Deprecated.

getRenderedUrl(Map<String, Object>) - Method in interface com.atlassian.plugin.web.model.WebLink

Deprecated.

getSection() - Method in class com.atlassian.plugin.web.api.model.WebItemImpl

getSection() - Method in interface com.atlassian.plugin.web.api.WebItem

getSection() - Method in interface com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor

getSections(Map<String, Object>) - Method in interface com.atlassian.plugin.web.api.provider.WebSectionProvider

Returns a list of web-sections for a given context.

getSections(String) - Method in interface com.atlassian.plugin.web.WebInterfaceManager

Deprecated.

as of 3.0.2 use DynamicWebInterfaceManager.getWebSections(String, java.util.Map)

getStyleClass() - Method in class com.atlassian.plugin.web.api.model.AbstractWebFragment

getStyleClass() - Method in interface com.atlassian.plugin.web.api.WebFragment

getStyleClass() - Method in interface com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor

Returns the item style as a "class" String consisting of one or more style classes.

getTitle() - Method in class com.atlassian.plugin.web.api.model.AbstractWebFragment

getTitle() - Method in interface com.atlassian.plugin.web.api.WebFragment

getTooltip() - Method in interface com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor

getUrl() - Method in class com.atlassian.plugin.web.api.model.WebItemImpl

getUrl() - Method in interface com.atlassian.plugin.web.api.WebItem

getUrl() - Method in interface com.atlassian.plugin.web.model.WebIcon

Deprecated.

getWebFragmentHelper() - Method in interface com.atlassian.plugin.web.WebInterfaceManager

getWebItems(String, Map<String, Object>) - Method in interface com.atlassian.plugin.web.api.DynamicWebInterfaceManager

Returns a collection of web-items for the provided section.

getWebLabel() - Method in interface com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor

getWebPanelDescriptors(String) - Method in interface com.atlassian.plugin.web.WebInterfaceManager

getWebPanels(String) - Method in interface com.atlassian.plugin.web.WebInterfaceManager

getWebParams() - Method in interface com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor

getWebSections(String, Map<String, Object>) - Method in interface com.atlassian.plugin.web.api.DynamicWebInterfaceManager

Returns a collection of web-sections for the provided location.

getWeight() - Method in class com.atlassian.plugin.web.api.model.AbstractWebFragment

getWeight() - Method in interface com.atlassian.plugin.web.api.WebFragment

getWeight() - Method in interface com.atlassian.plugin.web.descriptors.WebFragmentModuleDescriptor

getWeight() - Method in interface com.atlassian.plugin.web.descriptors.WeightedDescriptor

getWidth() - Method in interface com.atlassian.plugin.web.model.WebIcon

Deprecated.

H

hasAccessKey() - Method in interface com.atlassian.plugin.web.model.WebLink

Deprecated.

hasSectionsForLocation(String) - Method in interface com.atlassian.plugin.web.WebInterfaceManager

I

id(String) - Method in class com.atlassian.plugin.web.api.model.WebFragmentBuilder

init(Map<String, String>) - Method in interface com.atlassian.plugin.web.Condition

Called after creation and autowiring.

init(Map<String, String>) - Method in class com.atlassian.plugin.web.conditions.AbstractCompositeCondition

init(Map<String, String>) - Method in class com.atlassian.plugin.web.conditions.AlwaysDisplayCondition

init(Map<String, String>) - Method in class com.atlassian.plugin.web.conditions.InvertedCondition

init(Map<String, String>) - Method in class com.atlassian.plugin.web.conditions.NeverDisplayCondition

init(Map<String, String>) - Method in interface com.atlassian.plugin.web.ContextProvider

Called after creation and autowiring.

InvertedCondition - Class in com.atlassian.plugin.web.conditions

InvertedCondition(Condition) - Constructor for class com.atlassian.plugin.web.conditions.InvertedCondition

L

label(String) - Method in class com.atlassian.plugin.web.api.model.WebFragmentBuilder

loadCondition(String, Plugin) - Method in interface com.atlassian.plugin.web.WebFragmentHelper

Deprecated.

Since 2.7.0, will use HostContainer.create in future versions

loadContextProvider(String, Plugin) - Method in interface com.atlassian.plugin.web.WebFragmentHelper

Creates a context provider instance.

N

NeverDisplayCondition - Class in com.atlassian.plugin.web.conditions

Always hide a web link.

NeverDisplayCondition() - Constructor for class com.atlassian.plugin.web.conditions.NeverDisplayCondition

O

OrCompositeCondition - Class in com.atlassian.plugin.web.conditions

OrCompositeCondition() - Constructor for class com.atlassian.plugin.web.conditions.OrCompositeCondition

OrCompositeCondition(Condition...) - Constructor for class com.atlassian.plugin.web.conditions.OrCompositeCondition

P

params(Map<String, String>) - Method in class com.atlassian.plugin.web.api.model.WebFragmentBuilder

R

refresh() - Method in interface com.atlassian.plugin.web.WebInterfaceManager

Refresh the contents of the web interface manager.

renderVelocityFragment(String, Map<String, Object>) - Method in interface com.atlassian.plugin.web.WebFragmentHelper

Renders the string fragment as a Velocity template

S

shouldDisplay(Map<String, Object>) - Method in interface com.atlassian.plugin.web.Condition

Determine whether the web fragment should be displayed

shouldDisplay(Map<String, Object>) - Method in class com.atlassian.plugin.web.conditions.AbstractCompositeCondition

shouldDisplay(Map<String, Object>) - Method in class com.atlassian.plugin.web.conditions.AlwaysDisplayCondition

shouldDisplay(Map<String, Object>) - Method in class com.atlassian.plugin.web.conditions.AndCompositeCondition

shouldDisplay(Map<String, Object>) - Method in class com.atlassian.plugin.web.conditions.InvertedCondition

shouldDisplay(Map<String, Object>) - Method in class com.atlassian.plugin.web.conditions.NeverDisplayCondition

shouldDisplay(Map<String, Object>) - Method in class com.atlassian.plugin.web.conditions.OrCompositeCondition

styleClass(String) - Method in class com.atlassian.plugin.web.api.model.WebFragmentBuilder

T

title(String) - Method in class com.atlassian.plugin.web.api.model.WebFragmentBuilder

toString() - Method in class com.atlassian.plugin.web.api.model.AbstractWebFragment

toStringOfFields() - Method in class com.atlassian.plugin.web.api.model.AbstractWebFragment

toStringOfFields() - Method in class com.atlassian.plugin.web.api.model.WebItemImpl

toStringOfFields() - Method in class com.atlassian.plugin.web.api.model.WebSectionImpl

U

url(String) - Method in class com.atlassian.plugin.web.api.model.WebFragmentBuilder.WebItemBuilder

W

WebFragment - Interface in com.atlassian.plugin.web.api

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

WebFragmentBuilder - Class in com.atlassian.plugin.web.api.model

WebFragmentBuilder(int) - Constructor for class com.atlassian.plugin.web.api.model.WebFragmentBuilder

WebFragmentBuilder(String, int) - Constructor for class com.atlassian.plugin.web.api.model.WebFragmentBuilder

WebFragmentBuilder.WebItemBuilder - Class in com.atlassian.plugin.web.api.model

WebFragmentBuilder.WebSectionBuilder - Class in com.atlassian.plugin.web.api.model

WebFragmentHelper - Interface in com.atlassian.plugin.web

Provides application specific methods to build/render web fragments

WebFragmentModuleDescriptor<T> - Interface in com.atlassian.plugin.web.descriptors

A convenience interface for web fragment descriptors

WebIcon - Interface in com.atlassian.plugin.web.model

Deprecated.

as of 3.0.2 use WebFragment.getStyleClass()

WebInterfaceManager - Interface in com.atlassian.plugin.web

A simple manager to provide sections of the web interface through plugins.

webItem(String) - Method in class com.atlassian.plugin.web.api.model.WebFragmentBuilder

WebItem - Interface in com.atlassian.plugin.web.api

Represents a link in a particular section

WebItemBuilder(WebFragmentBuilder, String) - Constructor for class com.atlassian.plugin.web.api.model.WebFragmentBuilder.WebItemBuilder

WebItemImpl - Class in com.atlassian.plugin.web.api.model

WebItemModuleDescriptor - Interface in com.atlassian.plugin.web.descriptors

A web-item plugin adds extra links to a particular section.

WebItemProvider - Interface in com.atlassian.plugin.web.api.provider

Allows plugins to provide dynamic web-items for a section and given context.

WebLabel - Interface in com.atlassian.plugin.web.model

Deprecated.

as of 3.0.2 use WebFragment.getLabel()

WebLink - Interface in com.atlassian.plugin.web.model

Deprecated.

as of 3.0.2 use WebItem

WebPanel - Interface in com.atlassian.plugin.web.model

The module that is responsive for providing the raw content for a Web Panel.

WebPanelModuleDescriptor - Interface in com.atlassian.plugin.web.descriptors

The web panel module declares a single web panel in atlassian-plugin.xml.

WebParam - Interface in com.atlassian.plugin.web.model

Deprecated.

as of 3.0.2 use WebFragment.getParams()

webSection(String) - Method in class com.atlassian.plugin.web.api.model.WebFragmentBuilder

WebSection - Interface in com.atlassian.plugin.web.api

Represents a logical grouping of various other WebSections or WebItems in a specific location.

WebSectionBuilder(WebFragmentBuilder, String) - Constructor for class com.atlassian.plugin.web.api.model.WebFragmentBuilder.WebSectionBuilder

WebSectionImpl - Class in com.atlassian.plugin.web.api.model

WebSectionModuleDescriptor - Interface in com.atlassian.plugin.web.descriptors

A web-section plugin adds extra sections to a particular location.

WebSectionProvider - Interface in com.atlassian.plugin.web.api.provider

Allows plugins to provide dynamic web-sections for a location and given context.

WEIGHTED_FRAGMENT_COMPARATOR - Static variable in class com.atlassian.plugin.web.api.model.WeightedComparator

WeightedComparator - Class in com.atlassian.plugin.web.api.model

Comparator that can be used to sort weighted WebFragments

WeightedComparator() - Constructor for class com.atlassian.plugin.web.api.model.WeightedComparator

WeightedDescriptor - Interface in com.atlassian.plugin.web.descriptors

A simple interface implemented by any weighted descriptors.

writeHtml(Writer, Map<String, Object>) - Method in interface com.atlassian.plugin.web.model.WebPanel

Writes the HTML for this panel into the supplied writer.

A B C D G H I L N O P R S T U W