com.jbbres.lib.actions.elements
Interface Category

All Superinterfaces:

java.lang.Comparable<Category>

All Known Implementing Classes:

CalendarCategory, ContactsCategory, DeveloperCategory, DocumentsCategory, EmailCategory, FilesCategory, ImagesCategory, InternetCategory, JavaCategory, MusicCategory, OtherCategory, SimpleCategory, TextCategory, VideosCategory

public interface Category
extends java.lang.Comparable<Category>

An interface representing a category of Elements.

Categories are used in the library to provide a better classification of the elements.

Release Notes:

v1.1.0:

Updated to be compatible with search editors

Since:

1.0.0

Version:

1.1.0

Author:

Jean-Baptiste Bres

Nested Class Summary

static class

Category.SearchField A search field associated to the category object.

Method Summary

java.lang.String	getDescription() Returns the description of the category.
javax.swing.ImageIcon	getIcon() Returns the icon representing the category.
java.lang.String	getID() Returns the unique ID of the category.
java.lang.String	getName() Returns the name of the category.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getDescription

java.lang.String getDescription()

Returns the description of the category.

This method not used by Action(s) yet.

Returns:

the description of the category.

getIcon

javax.swing.ImageIcon getIcon()

Returns the icon representing the category.

Returns:

the icon representing the category.

getName

java.lang.String getName()

Returns the name of the category.

Returns:

the name of the category

getID

java.lang.String getID()

Returns the unique ID of the category.

An action can define that it is member of a category by stating #id in its list of categories.

Returns:

the unique ID of the category