Uses of Class
org.opencms.relations.CmsCategory

Packages that use CmsCategory

Package	Description
org.opencms.gwt	Provides core support for GWT.
org.opencms.gwt.shared	Core shared stuff.
org.opencms.jsp.util	Utility classes to be used for JSP pages.
org.opencms.relations	Classes to represent and validate the internal and external links/relations of resources in the OpenCms VFS.
org.opencms.search	Implements the main full text search and indexing functions available in OpenCms.
org.opencms.search.solr	The package contains the Solr search integration.
org.opencms.ui.components.categoryselect

Uses of CmsCategory in org.opencms.gwt

Method parameters in org.opencms.gwt with type arguments of type CmsCategory

Modifier and Type	Method	Description
static List<CmsCategoryTreeEntry>	CmsCoreService.buildCategoryTree(CmsObject cms, List<CmsCategory> categories)	Builds the tree structure for the given categories.

Uses of CmsCategory in org.opencms.gwt.shared

Constructors in org.opencms.gwt.shared with parameters of type CmsCategory

Modifier	Constructor	Description
	CmsCategoryBean(CmsCategory category)	Constructor.
	CmsCategoryTreeEntry(CmsCategory category)	Clone constructor.

Uses of CmsCategory in org.opencms.jsp.util

Methods in org.opencms.jsp.util that return types with arguments of type CmsCategory

Modifier and Type	Method	Description
List<CmsCategory>	CmsJspCategoryAccessBean.getAllItems()	Returns all wrapped categories.
List<CmsCategory>	CmsJspCategoryAccessBean.getLeafItems()	Returns only the leaf categories of the wrapped categories.
Map<String,CmsCategory>	CmsJspStandardContextBean.getReadCategory()	Transforms the category path of a category to the category.
Map<String,List<CmsCategory>>	CmsJspStandardContextBean.getReadPathCategories()	Transforms the category path to the list of all categories on that path.
List<CmsCategory>	CmsJspCategoryAccessBean.getTopItems()	Returns all categories that are direct children of the current main category.

Uses of CmsCategory in org.opencms.relations

Methods in org.opencms.relations that return CmsCategory

Modifier and Type	Method	Description
CmsCategory	CmsCategoryService.createCategory(CmsObject cms, CmsCategory parent, String name, String title, String description, String referencePath)	Creates a new category.
CmsCategory	CmsCategoryService.getCategory(CmsObject cms, String categoryRootPath)	Creates a category from the given category root path.
CmsCategory	CmsCategoryService.getCategory(CmsObject cms, CmsResource resource)	Creates a category from the given resource.
CmsCategory	CmsCategoryService.localizeCategory(CmsObject cms, CmsCategory category, Locale locale)	Localizes a single category by reading its locale-specific properties for title and description, if possible.
CmsCategory	CmsCategoryService.readCategory(CmsObject cms, String categoryPath, String referencePath)	Reads all categories identified by the given category path for the given reference path.

Methods in org.opencms.relations that return types with arguments of type CmsCategory

Modifier and Type	Method	Description
List<CmsCategory>	CmsCategoryService.localizeCategories(CmsObject cms, List<CmsCategory> categories, Locale locale)	Localizes a list of categories by reading locale-specific properties for their title and description, if possible.
List<CmsCategory>	CmsCategoryService.readCategories(CmsObject cms, String parentCategoryPath, boolean includeSubCats, String referencePath)	Returns all categories given some search parameters.
List<CmsCategory>	CmsCategoryService.readCategoriesForRepositories(CmsObject cms, String parentCategoryPath, boolean includeSubCats, List<String> repositories)	Returns all categories given some search parameters.
List<CmsCategory>	CmsCategoryService.readCategoriesForRepositories(CmsObject cms, String parentCategoryPath, boolean includeSubCats, List<String> repositories, boolean includeRepositories)	Returns all categories given some search parameters.
List<CmsCategory>	CmsCategoryService.readResourceCategories(CmsObject cms, String resourceName)	Reads the categories for a resource identified by the given resource name.
List<CmsCategory>	CmsCategoryService.readResourceCategories(CmsObject cms, CmsResource resource)	Reads the categories for a resource.

Methods in org.opencms.relations with parameters of type CmsCategory

Modifier and Type	Method	Description
void	CmsCategoryService.addResourceToCategory(CmsObject cms, String resourceName, CmsCategory category)	Adds a resource identified by the given resource name to the given category.
int	CmsCategory.compareTo(CmsCategory cat)
CmsCategory	CmsCategoryService.createCategory(CmsObject cms, CmsCategory parent, String name, String title, String description, String referencePath)	Creates a new category.
CmsCategory	CmsCategoryService.localizeCategory(CmsObject cms, CmsCategory category, Locale locale)	Localizes a single category by reading its locale-specific properties for title and description, if possible.
void	CmsCategoryService.removeResourceFromCategory(CmsObject cms, String resourceName, CmsCategory category)	Removes a resource identified by the given resource name from the given category.

Method parameters in org.opencms.relations with type arguments of type CmsCategory

Modifier and Type	Method	Description
List<CmsCategory>	CmsCategoryService.localizeCategories(CmsObject cms, List<CmsCategory> categories, Locale locale)	Localizes a list of categories by reading locale-specific properties for their title and description, if possible.

Constructors in org.opencms.relations with parameters of type CmsCategory

Modifier	Constructor	Description
	CmsCategory(CmsCategory other, String title, String description)	Creates a new category based on another one, keeping everything except title and description, which are passed in separately.

Uses of CmsCategory in org.opencms.search

Method parameters in org.opencms.search with type arguments of type CmsCategory

Modifier and Type	Method	Description
void	CmsLuceneDocument.addCategoryField(List<CmsCategory> categories)
void	I_CmsSearchDocument.addCategoryField(List<CmsCategory> categories)	Adds the list of the given categories to this document.

Uses of CmsCategory in org.opencms.search.solr

Method parameters in org.opencms.search.solr with type arguments of type CmsCategory

Modifier and Type	Method	Description
void	CmsSolrDocument.addCategoryField(List<CmsCategory> categories)

Uses of CmsCategory in org.opencms.ui.components.categoryselect

Methods in org.opencms.ui.components.categoryselect that return types with arguments of type CmsCategory

Modifier and Type	Method	Description
Collection<CmsCategory>	CmsCategoryTree.getSelectedCategories()	Returns the selected categories.

Method parameters in org.opencms.ui.components.categoryselect with type arguments of type CmsCategory

Modifier and Type	Method	Description
void	CmsCategorySelectDialog.addSelectionHandler(I_CmsSelectionHandler<Collection<CmsCategory>> selectionHandler)	Adds a selection handler.
void	CmsCategorySelectField.onSelection(Collection<CmsCategory> selected)
void	CmsCategorySelectDialog.removeSelectionHandler(I_CmsSelectionHandler<Collection<CmsCategory>> selectionHandler)	Removes a selection handler.
void	CmsCategoryTree.setCategories(List<CmsCategory> categories)	Fills the category tree.
void	CmsCategorySelectDialog.setSelectedCategories(Collection<CmsCategory> categories)	Sets the selected categories.
void	CmsCategoryTree.setSelectedCategories(Collection<CmsCategory> categories)	Sets the selected categories.