Uses of Interface
com.atlassian.confluence.labels.Labelable

Packages that use Labelable

Package	Description
com.atlassian.confluence.content
com.atlassian.confluence.core
com.atlassian.confluence.event.events.label
com.atlassian.confluence.labels
com.atlassian.confluence.labels.actions
com.atlassian.confluence.labels.service
com.atlassian.confluence.mail
com.atlassian.confluence.pages
com.atlassian.confluence.pages.templates
com.atlassian.confluence.plugins.labels.actions
com.atlassian.confluence.search.actions
com.atlassian.confluence.setup.settings
com.atlassian.confluence.spaces
com.atlassian.confluence.user
com.atlassian.confluence.userstatus
com.atlassian.confluence.util

Uses of Labelable in com.atlassian.confluence.content

Classes in com.atlassian.confluence.content that implement Labelable

Modifier and Type	Class and Description
class	CustomContentEntityObject Generic ContentEntityObject that plugins can use to extend Confluence's content system.

Uses of Labelable in com.atlassian.confluence.core

Classes in com.atlassian.confluence.core that implement Labelable

Modifier and Type	Class and Description
class	AbstractLabelableEntityObject
class	ContentEntityObject
class	ContentEntitySimulacrum A very generic SpaceContentEntityObject, used to play pretends when rendering page templates in preview / view modes.
class	PageContentEntityObject Deprecated. Since 4.0 This used to be implemented by Comment, but is no longer necessary.
class	SpaceContentEntityObject A ContentEntityObject that is a first-class member of a Space (i.e.

Uses of Labelable in com.atlassian.confluence.event.events.label

Fields in com.atlassian.confluence.event.events.label declared as Labelable

Modifier and Type	Field and Description
protected Labelable	LabelEvent.labelled

Methods in com.atlassian.confluence.event.events.label that return Labelable

Modifier and Type	Method and Description
Labelable	LabelEvent.getLabelled()

Constructors in com.atlassian.confluence.event.events.label with parameters of type Labelable

Constructor and Description
LabelAddEvent(Label source, Labelable labelled)
LabelEvent(Label source, Labelable labelled)
LabelRemoveEvent(Label source, Labelable labelled)

Uses of Labelable in com.atlassian.confluence.labels

Subinterfaces of Labelable in com.atlassian.confluence.labels

Modifier and Type	Interface and Description
interface	EditableLabelable An interface which extends the immutable interface of Labelable with functionality to be able to add and remove labels.

Classes in com.atlassian.confluence.labels that implement Labelable

Modifier and Type	Class and Description
class	PermittedLabelView This wrapper exposes only those labels and functions of the labelable object that the specified user is permitted to view.

Methods in com.atlassian.confluence.labels that return Labelable

Modifier and Type	Method and Description
Labelable	PermittedLabelView.getDelegate()

Methods in com.atlassian.confluence.labels that return types with arguments of type Labelable

Modifier and Type	Method and Description
List<? extends Labelable>	LabelManager.getContentForAllLabels(Collection<Label> labels, int maxResults, int offset) Deprecated. since 5.3. Use LabelManager.getContentForAllLabels(int, int, Label...) instead.
List<? extends Labelable>	DefaultLabelManager.getContentForAllLabels(Collection<Label> labels, int maxResults, int offset)
List<? extends Labelable>	CachingLabelManager.getContentForAllLabels(Collection<Label> labels, int maxResults, int offset) Deprecated.
List<? extends Labelable>	LabelManager.getContentForLabel(Label label, int maxResults) Deprecated. since 5.3. Use LabelManager.getAllContentForLabel(int, int, Label).
List<? extends Labelable>	DefaultLabelManager.getContentForLabel(Label label, int maxResults)
List<? extends Labelable>	CachingLabelManager.getContentForLabel(Label label, int maxResults) Deprecated.
List<? extends Labelable>	LabelManager.getCurrentContentForLabel(Label label) Deprecated. since 5.3. Use LabelManager.getContentForLabel(int, int, Label).
List<? extends Labelable>	CachingLabelManager.getCurrentContentForLabel(Label label) Deprecated.
List<? extends Labelable>	LabelManager.getCurrentContentForLabelAndSpace(Label label, String spaceKey) Deprecated. since 5.3. Use the LabelManager.getContentInSpaceForLabel(int, int, String, Label).
List<? extends Labelable>	DefaultLabelManager.getCurrentContentForLabelAndSpace(Label label, String spaceKey)
List<? extends Labelable>	CachingLabelManager.getCurrentContentForLabelAndSpace(Label label, String spaceKey) Deprecated.
List<? extends Labelable>	LabelManager.getCurrentContentWithPersonalLabel(String username) Get all current content labelled by a user
List<? extends Labelable>	CachingLabelManager.getCurrentContentWithPersonalLabel(String username)

Methods in com.atlassian.confluence.labels with parameters of type Labelable

Modifier and Type	Method and Description
int	LabelManager.addLabel(Labelable content, Label label) Add a label to the specified content.
int	DefaultLabelManager.addLabel(Labelable labelable, Label label)
int	CachingLabelManager.addLabel(Labelable content, Label label)
Label	ParsedLabelName.addLabel(Labelable labelable, LabelManager labelManager)
List	LabelManager.getSuggestedLabels(Labelable content) Retrieve the DEFAULT_LABEL_COUNT suggested labels for the specified content.
List	DefaultLabelManager.getSuggestedLabels(Labelable content)
List	CachingLabelManager.getSuggestedLabels(Labelable content)
List	LabelManager.getSuggestedLabels(Labelable content, int maxResults) Retrieve the suggested labels for the specified content.
List	DefaultLabelManager.getSuggestedLabels(Labelable content, int count)
List	CachingLabelManager.getSuggestedLabels(Labelable content, int maxResults)
List	LabelManager.getSuggestedLabelsInSpace(Labelable content, String spaceKey) Retrieve the DEFAULT_LABEL_COUNT suggested labels for the specified content bound to the specified space.
List	DefaultLabelManager.getSuggestedLabelsInSpace(Labelable content, String spaceKey)
List	CachingLabelManager.getSuggestedLabelsInSpace(Labelable content, String spaceKey)
List<Label>	LabelManager.getSuggestedLabelsInSpace(Labelable content, String spaceKey, int maxResults) Retrieve the suggested labels for the specified content bound to the specified space.
List	DefaultLabelManager.getSuggestedLabelsInSpace(Labelable content, String spaceKey, int maxResults)
List<Label>	CachingLabelManager.getSuggestedLabelsInSpace(Labelable content, String spaceKey, int maxResults)
static boolean	LabelPermissionSupport.isLabelableByUser(Labelable object, PermissionManager permissionManager) Checks that the object permits labels to be edited by the logged in user.
void	LabelManager.removeAllLabels(Labelable content) Remove all of the labels from the specified content.
void	DefaultLabelManager.removeAllLabels(Labelable content)
void	CachingLabelManager.removeAllLabels(Labelable content)
int	LabelManager.removeLabel(Labelable object, Label label) Remove a label from the specified content.
int	DefaultLabelManager.removeLabel(Labelable content, Label label)
int	CachingLabelManager.removeLabel(Labelable object, Label label)
void	LabelManager.removeLabels(Labelable object, List labels) removes a list of labels from the labelable object
void	DefaultLabelManager.removeLabels(Labelable content, List labels)
void	CachingLabelManager.removeLabels(Labelable object, List labels)
static boolean	LabelPermissionSupport.userCanEditLabel(Label label, Labelable object, PermissionManager permissionManager)
static boolean	LabelPermissionSupport.userCanEditLabel(ParsedLabelName ref, Labelable object, PermissionManager permissionManager)
static boolean	LabelPermissionSupport.userCanViewObject(Labelable object, PermissionManager permissionManager)

Constructors in com.atlassian.confluence.labels with parameters of type Labelable

Constructor and Description
PermittedLabelView(Labelable original, com.atlassian.user.User actingUser, boolean hideSpecialLabels)

Uses of Labelable in com.atlassian.confluence.labels.actions

Methods in com.atlassian.confluence.labels.actions that return Labelable

Modifier and Type	Method and Description
Labelable	RemoveSpaceFromFavouriteAjaxAction.getEntity() Used so that the links are correctly built when JS is disabled
Labelable	RemoveFavouriteAction.getEntity() Used so that the links are correctly built when JS is disabled
Labelable	AddSpaceToFavouriteAjaxAction.getEntity() Used so that the links are correctly built when JS is disabled
Labelable	AddFavouriteAction.getEntity() Used so that the links are correctly built when JS is disabled

Uses of Labelable in com.atlassian.confluence.labels.service

Methods in com.atlassian.confluence.labels.service that return Labelable

Modifier and Type	Method and Description
Labelable	RemoveLabelCommand.getEntity() Returns the page or blog post that the label was removed from.
Labelable	AddLabelsCommand.getEntity() Returns the page or blog post that the label was added to
Labelable	AbstractLabelsCommand.getEntity()

Uses of Labelable in com.atlassian.confluence.mail

Classes in com.atlassian.confluence.mail that implement Labelable

Modifier and Type	Class and Description
class	Mail Deprecated. since 4.2. Mail archiving is now managed entirely by the mail archiving plugin.

Uses of Labelable in com.atlassian.confluence.pages

Classes in com.atlassian.confluence.pages that implement Labelable

Modifier and Type	Class and Description
class	AbstractPage Parent of the concrete Page and BlogPost classes
class	Attachment
class	BlogPost
class	Comment
class	Draft This is the old way of dealing with drafts in Confluence and will be deprecated soon.
class	Page Represents a Page within Confluence.

Uses of Labelable in com.atlassian.confluence.pages.templates

Classes in com.atlassian.confluence.pages.templates that implement Labelable

Modifier and Type	Class and Description
class	PageTemplate

Uses of Labelable in com.atlassian.confluence.plugins.labels.actions

Methods in com.atlassian.confluence.plugins.labels.actions that return Labelable

Modifier and Type	Method and Description
Labelable	RemoveLabelAction.getEntity() Used so that the links are correctly built when JS is disabled
Labelable	AddLabelAction.getEntity() Used so that the links are correctly built when JS is disabled

Methods in com.atlassian.confluence.plugins.labels.actions with parameters of type Labelable

Modifier and Type	Method and Description
List<DisplayableLabel>	ViewLabelAction.getOtherLabels(Labelable content) Returns the first nine global labels on the given content that are not this.label.

Uses of Labelable in com.atlassian.confluence.search.actions

Methods in com.atlassian.confluence.search.actions with parameters of type Labelable

Modifier and Type	Method and Description
String	SearchSiteAction.getLabelNames(Labelable obj) Deprecated. Retrieve a comma separated string of label names.

Uses of Labelable in com.atlassian.confluence.setup.settings

Classes in com.atlassian.confluence.setup.settings that implement Labelable

Modifier and Type	Class and Description
class	GlobalDescription Content Entity Object that is associated with the whole confluence rather then a specific space/page/user.

Uses of Labelable in com.atlassian.confluence.spaces

Classes in com.atlassian.confluence.spaces that implement Labelable

Modifier and Type	Class and Description
class	SpaceDescription

Uses of Labelable in com.atlassian.confluence.user

Classes in com.atlassian.confluence.user that implement Labelable

Modifier and Type	Class and Description
class	PersonalInformation

Uses of Labelable in com.atlassian.confluence.userstatus

Classes in com.atlassian.confluence.userstatus that implement Labelable

Modifier and Type	Class and Description
class	UserStatus Deprecated. since 5.9.1 Stores a short message representing a status from a User. Not attached to any space

Uses of Labelable in com.atlassian.confluence.util

Methods in com.atlassian.confluence.util with parameters of type Labelable

Modifier and Type	Method and Description
static Label	LabelUtil.addLabel(String labelReference, LabelManager labelManager, Labelable object) Adds the label to the specified object.
static Label	LabelUtil.addLabel(String labelReference, LabelManager labelManager, Labelable object, ConfluenceUser user) Adds the label to the specified object.
static String	LabelUtil.convertToDelimitedString(Labelable obj, com.atlassian.user.User user) Helper method converting list of labels associated with the labelable object into a space separated string of the label names.
static boolean	LabelUtil.syncState(Collection<String> labelNames, LabelManager labelManager, com.atlassian.user.User user, Labelable dest)
static boolean	LabelUtil.syncState(List<Label> source, LabelManager labelManager, com.atlassian.user.User user, Labelable dest)
static boolean	LabelUtil.syncState(String source, LabelManager labelManager, com.atlassian.user.User user, Labelable dest) Neat method that will synchronize a space separated list of label names with the labels contained within the labelable object.
static boolean	LabelUtil.syncState(String source, LabelManager labelManager, com.atlassian.user.User user, Labelable dest, boolean ignored) Deprecated. since 5.1. Use LabelUtil.syncState(String, LabelManager, User, Labelable)