API for the Image Style Application
Last modified by Admin on 2024/12/11 00:09
 | API to get defined Image styles. |
| Type | JAR |
| Category | API |
| Developed by | |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
| Bundled With | XWiki Standard |
| Compatibility | 14.3RC1+ |
Table of contents
Description
This module provide the Java APIs of the Image Style Extensions.
Image Style Manager
/**
* Gives access to the image styles of the wiki.
*
* @version $Id: e4c60400ac8104e836d33f71ad168a2e83959f63 $
* @since 14.3RC1
*/
@Role
@Unstable
public interface ImageStyleManager
{
/**
* The list of styles for a given wiki.
*
* @param wikiName the wiki name (e.g. {@code xwiki})
* @return the list of styles for the given wiki
* @throws ImageStyleException if an error occurs while retrieving the image styles
*/
Set<ImageStyle> getImageStyles(String wikiName) throws ImageStyleException;
}
* Gives access to the image styles of the wiki.
*
* @version $Id: e4c60400ac8104e836d33f71ad168a2e83959f63 $
* @since 14.3RC1
*/
@Role
@Unstable
public interface ImageStyleManager
{
/**
* The list of styles for a given wiki.
*
* @param wikiName the wiki name (e.g. {@code xwiki})
* @return the list of styles for the given wiki
* @throws ImageStyleException if an error occurs while retrieving the image styles
*/
Set<ImageStyle> getImageStyles(String wikiName) throws ImageStyleException;
}
Prerequisites & Installation Instructions
We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager).
You can also use the manual method which involves dropping the JAR file and all its dependencies into the WEB-INF/lib folder and restarting XWiki.
Dependencies
Dependencies for this extension (org.xwiki.platform:xwiki-platform-image-style-api 16.10.1):
- org.xwiki.commons:xwiki-commons-stability 16.10.1
- org.xwiki.platform:xwiki-platform-configuration-default 16.10.1
