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.impl.labels
com.atlassian.confluence.impl.search.actions
com.atlassian.confluence.labels
com.atlassian.confluence.labels.actions
com.atlassian.confluence.labels.service
com.atlassian.confluence.pages
com.atlassian.confluence.pages.templates
com.atlassian.confluence.plugins.labels.actions
com.atlassian.confluence.setup.settings
com.atlassian.confluence.spaces
com.atlassian.confluence.user
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	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	Description
class	AbstractLabelableEntityObject
class	ContentEntityObject
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	Description
protected Labelable	LabelEvent.labelled

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

Modifier and Type	Method	Description
Labelable	LabelEvent.getLabelled()

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

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

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

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

Modifier and Type	Method	Description
List<? extends Labelable>	CachingLabelManager.getContent(Label label)
List<? extends Labelable>	CachingLabelManager.getContentForAllLabels(Collection<Label> labels, int maxResults, int offset)
List<? extends Labelable>	CachingLabelManager.getCurrentContentForLabel(Label label)
List<? extends Labelable>	CachingLabelManager.getCurrentContentForLabelAndSpace(Label label, String spaceKey)
List<? extends Labelable>	CachingLabelManager.getCurrentContentWithPersonalLabel(String username)

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

Modifier and Type	Method	Description
int	CachingLabelManager.addLabel(Labelable content, Label label)
List<Label>	CachingLabelManager.getSuggestedLabels(Labelable content)
List<Label>	CachingLabelManager.getSuggestedLabels(Labelable content, int maxResults)
List<Label>	CachingLabelManager.getSuggestedLabelsInSpace(Labelable content, String spaceKey)
List<Label>	CachingLabelManager.getSuggestedLabelsInSpace(Labelable content, String spaceKey, int maxResults)
boolean	LabelPermissionEnforcerImpl.isLabelableByUser(Labelable object)
void	CachingLabelManager.removeAllLabels(Labelable content)
int	CachingLabelManager.removeLabel(Labelable object, Label label)
void	CachingLabelManager.removeLabels(Labelable object, List<Label> labels)
boolean	LabelPermissionEnforcerImpl.userCanEditLabel(Label label, Labelable object)
boolean	LabelPermissionEnforcerImpl.userCanEditLabel(ParsedLabelName ref, Labelable object)
boolean	LabelPermissionEnforcerImpl.userCanViewObject(Labelable object)

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

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

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

Uses of Labelable in com.atlassian.confluence.labels

Subinterfaces of Labelable in com.atlassian.confluence.labels

Modifier and Type	Interface	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	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	Description
Labelable	PermittedLabelView.getDelegate()

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

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

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

Modifier and Type	Method	Description
int	DefaultLabelManager.addLabel(Labelable labelable, Label label)
int	LabelManager.addLabel(Labelable content, Label label)	Add a label to the specified content.
Label	ParsedLabelName.addLabel(Labelable labelable, LabelManager labelManager)	Deprecated, for removal: This API element is subject to removal in a future version. since 9.3
List<Label>	DefaultLabelManager.getSuggestedLabels(Labelable content)
List<Label>	DefaultLabelManager.getSuggestedLabels(Labelable content, int count)
List<Label>	LabelManager.getSuggestedLabels(Labelable content)	Retrieve the DEFAULT_LABEL_COUNT suggested labels for the specified content.
List<Label>	LabelManager.getSuggestedLabels(Labelable content, int maxResults)	Retrieve the suggested labels for the specified content.
List<Label>	DefaultLabelManager.getSuggestedLabelsInSpace(Labelable content, String spaceKey)
List<Label>	DefaultLabelManager.getSuggestedLabelsInSpace(Labelable content, String spaceKey, int maxResults)
List<Label>	LabelManager.getSuggestedLabelsInSpace(Labelable content, String spaceKey)	Retrieve the DEFAULT_LABEL_COUNT suggested labels for the specified content bound to the specified space.
List<Label>	LabelManager.getSuggestedLabelsInSpace(Labelable content, String spaceKey, int maxResults)	Retrieve the suggested labels for the specified content bound to the specified space.
boolean	LabelPermissionEnforcer.isLabelableByUser(Labelable object)	Checks that the object permits labels to be edited by the logged in user.
static boolean	LabelPermissionSupport.isLabelableByUser(Labelable object, PermissionManager permissionManager)	Deprecated. Checks that the object permits labels to be edited by the logged in user.
void	DefaultLabelManager.removeAllLabels(Labelable content)
void	LabelManager.removeAllLabels(Labelable content)	Remove all of the labels from the specified content.
int	DefaultLabelManager.removeLabel(Labelable content, Label label)
int	LabelManager.removeLabel(Labelable object, Label label)	Remove a label from the specified content.
void	DefaultLabelManager.removeLabels(Labelable content, List<Label> labels)
void	LabelManager.removeLabels(Labelable object, List<Label> labels)	removes a list of labels from the labelable object
boolean	LabelPermissionEnforcer.userCanEditLabel(Label label, Labelable object)	Check if the user can edit a label of an object
boolean	LabelPermissionEnforcer.userCanEditLabel(ParsedLabelName ref, Labelable object)	Check if the user can edit a label of an object
static boolean	LabelPermissionSupport.userCanEditLabel(Label label, Labelable object, PermissionManager permissionManager)	Deprecated.
static boolean	LabelPermissionSupport.userCanEditLabel(ParsedLabelName ref, Labelable object, PermissionManager permissionManager)	Deprecated.
boolean	LabelPermissionEnforcer.userCanViewObject(Labelable object)	Check if the user can view the labelable object
static boolean	LabelPermissionSupport.userCanViewObject(Labelable object, PermissionManager permissionManager)	Deprecated.

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

Modifier	Constructor	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	Description
Labelable	AddFavouriteAction.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	RemoveFavouriteAction.getEntity()	Used so that the links are correctly built when JS is disabled
Labelable	RemoveSpaceFromFavouriteAjaxAction.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	Description
Labelable	AddLabelsCommand.getEntity()	Returns the page or blog post that the label was added to
Labelable	RemoveLabelCommand.getEntity()	Returns the page or blog post that the label was removed from.

Uses of Labelable in com.atlassian.confluence.pages

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

Modifier and Type	Class	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	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	Description
Labelable	AddLabelAction.getEntity()	Used so that the links are correctly built when JS is disabled
Labelable	RemoveLabelAction.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	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.setup.settings

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

Modifier and Type	Class	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	Description
class	ReadOnlySpaceDescription
class	SpaceDescription

Uses of Labelable in com.atlassian.confluence.user

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

Modifier and Type	Class	Description
class	PersonalInformation

Uses of Labelable in com.atlassian.confluence.util

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

Modifier and Type	Method	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(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.
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)