A C F G H I L M O P R S U V
All Classes All Packages

A

addIcon(String, Icon) - Method in class org.xwiki.icon.IconSet

Add an icon to the icon set.

C

clear() - Method in interface org.xwiki.icon.IconSetCache

Clear all the cache.

clear(String) - Method in interface org.xwiki.icon.IconSetCache

Remove from the cache an icon set corresponding to a given name.

clear(String, String) - Method in interface org.xwiki.icon.IconSetCache

Remove from the cache an icon set corresponding to a given name.

clear(DocumentReference) - Method in interface org.xwiki.icon.IconSetCache

Remove from the cache an icon set corresponding to a document in the wiki.

F

FONT - org.xwiki.icon.IconType

Icon displayed with a font.

G

get(String) - Method in interface org.xwiki.icon.IconSetCache

Get an icon set, from its name.

get(String, String) - Method in interface org.xwiki.icon.IconSetCache

Get an icon set, from its name and the icon where it is located.

get(DocumentReference) - Method in interface org.xwiki.icon.IconSetCache

Get the icon set corresponding to a document on the wiki.

getCss() - Method in class org.xwiki.icon.IconSet

getCurrentIconSet() - Method in interface org.xwiki.icon.IconSetManager

Get the icon set defined in the preferences of the wiki.

getDefaultIconSet() - Method in interface org.xwiki.icon.IconSetManager

Get the default icon set (from the WAR).

getIcon(String) - Method in class org.xwiki.icon.IconSet

getIconCssClass() - Method in class org.xwiki.icon.IconSet

getIconNames() - Method in interface org.xwiki.icon.IconManager

Get the list of the names of all available icons in the current icon set.

getIconNames() - Method in class org.xwiki.icon.IconSet

getIconNames(String) - Method in interface org.xwiki.icon.IconManager

Get the list of the names of all available icons in the specified icon set.

getIconSet(String) - Method in interface org.xwiki.icon.IconSetManager

Get icon set by name.

getIconSetNames() - Method in interface org.xwiki.icon.IconSetManager

Get the name of all the icon sets present in the current wiki.

getIconUrl() - Method in class org.xwiki.icon.IconSet

getJsx() - Method in class org.xwiki.icon.IconSet

getMetaData(String) - Method in interface org.xwiki.icon.IconManager

Generates metadata of an icon.

getMetaData(String, String) - Method in interface org.xwiki.icon.IconManager

Generates metadata of an icon.

getMetaData(String, String, boolean) - Method in interface org.xwiki.icon.IconManager

Generates metadata of an icon.

getName() - Method in class org.xwiki.icon.IconSet

getRenderHTML() - Method in class org.xwiki.icon.IconSet

getRenderWiki() - Method in class org.xwiki.icon.IconSet

getSsx() - Method in class org.xwiki.icon.IconSet

getType() - Method in class org.xwiki.icon.IconSet

getValue() - Method in class org.xwiki.icon.Icon

H

hasIcon(String) - Method in interface org.xwiki.icon.IconManager

Checks if the provided icon name exists in the current icon set.

hasIcon(String) - Method in class org.xwiki.icon.IconSet

Checks if the provided icon name exists in the icon set.

hasIcon(String, String) - Method in interface org.xwiki.icon.IconManager

Checks if the provided icon name exists in the a given icon set.

I

Icon - Class in org.xwiki.icon

An icon that have a name and a value to help rendering it.

Icon() - Constructor for class org.xwiki.icon.Icon

Default constructor.

Icon(String) - Constructor for class org.xwiki.icon.Icon

Constructor.

IconException - Exception in org.xwiki.icon

Exception relating to icon manipulations.

IconException(String, Throwable) - Constructor for exception org.xwiki.icon.IconException

Constructor.

IconManager - Interface in org.xwiki.icon

Component to render an icon, depending on the current icon theme set on the preferences.

IconRenderer - Interface in org.xwiki.icon

Component to render an icon (either with Wiki Syntax or HTML).

IconSet - Class in org.xwiki.icon

A collection of icons, with some properties to display them.

IconSet(String) - Constructor for class org.xwiki.icon.IconSet

Constructor.

IconSetCache - Interface in org.xwiki.icon

A cache to store the already loaded icon sets.

IconSetLoader - Interface in org.xwiki.icon

Component to load an IconSet.

IconSetManager - Interface in org.xwiki.icon

Component to get the icon sets from the Wiki instance (from the WAR of from a wiki page).

IconType - Enum in org.xwiki.icon

All the types that an Icon can be.

IMAGE - org.xwiki.icon.IconType

Icon displayed with an image (an image HTML tag).

L

loadIconSet(Reader, String) - Method in interface org.xwiki.icon.IconSetLoader

Load an icon set from any string input.

loadIconSet(DocumentReference) - Method in interface org.xwiki.icon.IconSetLoader

Load an icon set from a document in the wiki.

M

META_DATA_CSS_CLASS - Static variable in interface org.xwiki.icon.IconManager

CSS class of the icon.

META_DATA_ICON_SET_NAME - Static variable in interface org.xwiki.icon.IconManager

Icon set name used.

META_DATA_ICON_SET_TYPE - Static variable in interface org.xwiki.icon.IconManager

Type of the icon set used.

META_DATA_URL - Static variable in interface org.xwiki.icon.IconManager

URL of the icon image.

O

org.xwiki.icon - package org.xwiki.icon

P

put(String, String, IconSet) - Method in interface org.xwiki.icon.IconSetCache

Put an iconset into this cache.

put(String, IconSet) - Method in interface org.xwiki.icon.IconSetCache

Put an iconset into this cache.

put(DocumentReference, IconSet) - Method in interface org.xwiki.icon.IconSetCache

Put an iconset into this cache.

R

render(String) - Method in interface org.xwiki.icon.IconManager

Generate the wiki syntax to display an icon with the current icon theme.

render(String, String) - Method in interface org.xwiki.icon.IconManager

Generate the wiki syntax to display an icon with the specified icon theme.

render(String, String, boolean) - Method in interface org.xwiki.icon.IconManager

Generate the wiki syntax to display an icon with the specified icon theme.

render(String, IconSet) - Method in interface org.xwiki.icon.IconRenderer

Generate the wiki syntax to display an icon.

render(String, IconSet, String) - Method in interface org.xwiki.icon.IconRenderer

Render an icon with the specified renderer.

renderHTML(String) - Method in interface org.xwiki.icon.IconManager

Generate the HTML code to display an icon.

renderHTML(String, String) - Method in interface org.xwiki.icon.IconManager

Generate the HTML code to display an icon with the specified icon theme.

renderHTML(String, String, boolean) - Method in interface org.xwiki.icon.IconManager

Generate the HTML code to display an icon with the specified icon theme.

renderHTML(String, IconSet) - Method in interface org.xwiki.icon.IconRenderer

Generate the HTML code to display an icon.

S

setCss(String) - Method in class org.xwiki.icon.IconSet

Set the URL of a CSS file to enable to display this icon set properly.

setIconCssClass(String) - Method in class org.xwiki.icon.IconSet

Set the css class of the icon.

setIconUrl(String) - Method in class org.xwiki.icon.IconSet

Set the url of the icon.

setJsx(String) - Method in class org.xwiki.icon.IconSet

Set the page name of a JSX document to enable to display the icon set properly.

setName(String) - Method in class org.xwiki.icon.IconSet

Set the name of the icon set.

setRenderHTML(String) - Method in class org.xwiki.icon.IconSet

Set the HTML code (containing velocity) to display an icon from this set.

setRenderWiki(String) - Method in class org.xwiki.icon.IconSet

Set the wiki code (containing velocity) to display an icon from this set.

setSsx(String) - Method in class org.xwiki.icon.IconSet

Set the page name of a SSX document to enable to display the icon set properly.

setType(IconType) - Method in class org.xwiki.icon.IconSet

Set the type of icons that contains this set.

setValue(String) - Method in class org.xwiki.icon.Icon

Set the value of the icon.

U

use(IconSet) - Method in interface org.xwiki.icon.IconRenderer

Pull the necessary resources to use the specified icon set.

V

valueOf(String) - Static method in enum org.xwiki.icon.IconType

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.xwiki.icon.IconType

Returns an array containing the constants of this enum type, in the order they are declared.

A C F G H I L M O P R S U V
All Classes All Packages