@sitevision/api 2.0.0-alpha.0 → 2.0.0-alpha.2

package/hidden/senselogic/sitevision/api/redirect/RedirectUtil/index.d.ts

@@ -1,73 +0,0 @@
-import Node from "../../../../../javax/jcr/Node";
-
-/**
- * Redirect utility interface (301 redirects for <em>"old urls"</em>).
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getRedirectUtil()}.
- *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
- * @author Magnus Lövgren
- * @since Sitevision 4.0.3
- */
-
-interface RedirectUtil {
-  /**
-   * Gets all 301 redirect URIs registered for a specific node.
-   * @param aNode a node, typically a <code>sv:page</code>
-   * @return a set of 301 redirect URIs for <code>aNode</code>, never <code>null</code>
-   */
-  getRedirectURIs(aNode: Node): Set<unknown>;
-
-  /**
-   * Adds a relative URI that should trigger a 301 redirect to a specific node.
-   *
-   * <p>
-   *    Permission note! Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on <code>aNode</code>.
-   * </p>
-   * @param aNode a node, typically a <code>sv:page</code>
-   * @param aRelativeURI the relative URI that should trigger a 301 redirect to <code>aNode</code>.
-   * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or an invalid node, if <code>aRelativeURI</code> is <code>null</code>, whitespace-only or an absolute URI.
-   * @throws RepositoryException if current user is not authorized to alter <code>aNode</code>, if <code>aNode</code> is already locked or something else goes wrong
-   */
-  addRedirectURI(aNode: Node, aRelativeURI: java.lang.String): void;
-
-  /**
-   * Adds a collection of relative URIs that should trigger 301 redirects to a specific node.
-   *
-   * <p>
-   *    Permission note! Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on <code>aNode</code>.
-   * </p>
-   * @param aNode a node, typically a <code>sv:page</code>
-   * @param aRelativeURIs a collection of relative URIs that should trigger 301 redirects to <code>aNode</code>.
-   * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or an invalid node, if <code>aRelativeURI</code> is <code>null</code>, empty or doesn't contain any non-whitespace only or an non-absolute URI.
-   * @throws RepositoryException if current user is not authorized to alter <code>aNode</code>, if <code>aNode</code> is already locked or something else goes wrong
-   */
-  addRedirectURIs(aNode: Node, aRelativeURIs: java.util.Collection): void;
-
-  /**
-   * Removes a relative 301 redirect URI from a specific node.
-   *
-   * <p>
-   *    Permission note! Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on <code>aNode</code>.
-   * </p>
-   * @param aNode a node, typically a <code>sv:page</code>
-   * @param aRelativeURI the relative URI that should be removed from <code>aNode</code>.
-   * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or an invalid node, if <code>aRelativeURI</code> is <code>null</code>, whitespace-only or an absolute URI.
-   * @throws RepositoryException if current user is not authorized to alter <code>aNode</code>, if <code>aNode</code> is already locked or something else goes wrong
-   */
-  removeRedirectURI(aNode: Node, aRelativeURI: java.lang.String): void;
-
-  /**
-   * Removes all relative 301 redirect URIs from a specific node.
-   *
-   * <p>
-   *    Permission note! Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on <code>aNode</code>.
-   * </p>
-   * @param aNode a node, typically a <code>sv:page</code>
-   * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or an invalid node,
-   * @throws RepositoryException if current user is not authorized to alter <code>aNode</code>, if <code>aNode</code> is already locked or something else goes wrong
-   */
-  removeAllRedirectURIs(aNode: Node): void;
-}

package/hidden/senselogic/sitevision/api/render/BuddyIconRenderer/index.d.ts

@@ -1,186 +0,0 @@
-import Node from "../../../../../javax/jcr/Node";
-
-/**
- * BuddyIconRenderer is a stateful utility interface for rendering of buddy icons for user identities and collaboration groups.
- *
- * <p>
- * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getBuddyIconRenderer()}.
- * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
- *
- * <p>
- *  BuddyIconRenderer has few attributes:
- * </p>
- * <ul>
- *    <li><em>buddyIconNode</em> - The node that should be rendered as a buddy icon. Default is <code>null</code>.
- *    </li>
- *    <li><em>buddyIconSize</em> - The size of the buddy icon that is rendered. Default is <code>BuddyIconSize.SMALL</code>. Note that image size
- *    settings are followed with best effort. Images will never be upscaled.
- *    </li>
- *    <li><em>linkBuddyIcon</em> - Whether or not rendered buddy icons should be linked. Default is <code>true</code>.
- *    </li>
- * </ul>
- *
- * <p>
- *   Using the BuddyIconRenderer is pretty straightforward, if you remember that it is <strong>stateful</strong> and that the previously
- *   loaded buddy icon node will be cleared whenever you try to load a new one. Conceptually you would typically use it like this:
- * </p>
- * <ol>
- *   <li>Get the BuddyIconRenderer</li>
- *   <li>Possibly init the renderer with rendering settings (buddyIconSize, linkBuddyIcon)</li>
- *   <li>Set a buddy icon node</li>
- *   <li>Do render</li>
- * </ol>
- * <p>
- * When you have rendered once, you can re-use the BuddyIconRenderer until you are done. Something like:
- * </p>
- * <ol>
- *   <li>Update the buddy icon node</li>
- *   <li>Do render.</li>
- * </ol>
- *
- * <p>
- *    <strong>Example of how this strategy could be implemented in Velocity:</strong><br>
- *    (You want to do a simple listing of buddy icons for some collaboration groups, collaboration group pages, user identities or users)
- * </p>
- * <pre><code>
- *   <em>## Get BuddyIconRenderer</em>
- *   #set ($buddyIconRenderer = $sitevisionUtils.buddyIconRenderer)
- *
- *   <em>## Iterate through the list of nodes and render a buddy icon for all supported nodes</em>
- *   &lt;ul class="sv-no-list-style"&gt;
- *   #foreach ($item in $items)
- *     <em>## Check if this node can be rendered as a buddy icon</em>
- *     #if ($buddyIconRenderer.isRenderable($item))
- *       <em>## Update the renderer and render</em>
- *       $buddyIconRenderer.update($item)
- *       &lt;li&gt;
- *          $buddyIconRenderer.render()
- *       &lt;/li&gt;
- *     #end
- *   #end
- *   &lt;/ul&gt;
- * </code></pre>
- * @author Magnus Lövgren
- * @since Sitevision 3.5.3
- */
-
-interface BuddyIconRenderer {
-  /**
-   * Sets the size for rendered buddy icons.
-   *
-   * <p>Default is <code>BuddyIconSize.SMALL</code></p>
-   * @param aBuddyIconSize the icon size
-   */
-  setBuddyIconSize(
-    aBuddyIconSize: senselogic.sitevision.api.render.BuddyIconRenderer.BuddyIconSize
-  ): void;
-
-  /**
-   * Utility method for executing <code>setBuddyIconSize(BuddyIconSize.SMALL)</code>
-   * @see #setBuddyIconSize(senselogic.sitevision.api.render.BuddyIconRenderer.BuddyIconSize)
-   * @see BuddyIconSize#SMALL
-   */
-  forceUseSmallBuddyIconSize(): void;
-
-  /**
-   * Utility method for executing <code>setBuddyIconSize(BuddyIconSize.LARGE)</code>
-   * @see #setBuddyIconSize(senselogic.sitevision.api.render.BuddyIconRenderer.BuddyIconSize)
-   * @see BuddyIconSize#LARGE
-   */
-  forceUseLargeBuddyIconSize(): void;
-
-  /**
-   * Utility method for executing <code>setBuddyIconSize(BuddyIconSize.X_LARGE)</code>
-   * @since Sitevision 8.2
-   * @see #setBuddyIconSize(senselogic.sitevision.api.render.BuddyIconRenderer.BuddyIconSize)
-   * @see BuddyIconSize#X_LARGE
-   */
-  forceUseXLargeBuddyIconSize(): void;
-
-  /**
-   * Whether or not rendered buddy icons should be linked.
-   *
-   * <p>Default is <code>true</code></p>
-   * @param aLinkBuddyIcon Whether or not buddy icons should be linked.
-   */
-  setLinkBuddyIcon(aLinkBuddyIcon: boolean): void;
-
-  /**
-   * Utility method for executing <code>setLinkBuddyIcon(false)</code>
-   * @see #setLinkBuddyIcon(boolean)
-   */
-  clearUseLinkBuddyIcon(): void;
-
-  /**
-   * Utility method for executing <code>setLinkBuddyIcon(true)</code>
-   * @see #setLinkBuddyIcon(boolean)
-   */
-  forceUseLinkBuddyIcon(): void;
-
-  /**
-   * Updates the renderer with a new buddy icon supported node.
-   *
-   * <p>
-   *    If <code>aBuddyIconNode</code> is not a type that can be represented by a buddy icon, the argument will be considered as <code>null</code>,
-   *    i.e. the renderer will not have any renderable node in subsequent render execution.
-   * </p>
-   * @param aBuddyIconNode a node that can be rendered as a buddy icon.
-   */
-  update(aBuddyIconNode: Node): void;
-
-  /**
-   * Whether or not this renderer contains a node that can be rendered.
-   * @return <code>true</code> if a renderable node is loaded, <code>false</code> if not.
-   */
-  isLoaded(): boolean;
-
-  /**
-   * Helper method to check if a certain node can be rendered as a buddy icon.
-   *
-   * <p>
-   *    Nodes with the following primary node types are potentially renderable:
-   * </p>
-   * <ul>
-   *    <li><code>sv:userIdentity</code></li>
-   *    <li><code>sv:user</code> <em>(non-anonymous)</em> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
-   *    <li><code>sv:simpleUser</code> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
-   *    <li style="margin-bottom:1em"><code>sv:systemUser</code> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
-   *    <li><code>sv:collaborationGroup</code></li>
-   *    <li><code>sv:collaborationGroupPage</code> &raquo; <em>will be renderable if a sv:collaborationGroup can be extracted</em></li>
-   * </ul>
-   * @param aNode the node to check
-   * @return <code>true</code> if <code>aNode</code> is supported by this renderer, <code>false</code> if not
-   */
-  isRenderable(aNode: Node): boolean;
-
-  /**
-   * BuddyIconInfo for current state.
-   *
-   * <p>
-   *    <em>
-   *       The data this method provides is used by the {@link #render()} method.
-   *       The intent of this method is to facilitate custom buddy icon rendering solutions.
-   *       See {@link BuddyIconInfo} for such example.
-   *    </em>
-   * </p>
-   *
-   * <p>
-   *    Note! Returned BuddyIconInfo object is never null but its <code>uri</code> will potentially be null and its
-   *    <code>width</code>/<code>height</code> might be zero.
-   *    Typically when this renderer has no valid/renderable node loaded, see {@link #isLoaded()}.
-   * </p>
-   * @return the BuddyIconInfo for current state, is never null.
-   * @since Sitevision 8.2
-   */
-  getBuddyIconInfo(): BuddyIconInfo;
-
-  /**
-   * Builds a html string based on current state.
-   *
-   * <strong>Size note!</strong> Profile images will never be upscaled. If a buddy icon size is larger than the actual size of the profile image,
-   * the image will be rendered with the largest possible buddy icon size.
-   * @return a html string, ready to print out on a page. Might be empty but never <code>null</code>.
-   */
-  render(): string;
-}

package/hidden/senselogic/sitevision/api/render/FileIconRenderer/index.d.ts

@@ -1,301 +0,0 @@
-/**
- * FileIconRenderer is a stateful utility interface that can be used to render valid xhtml img elements based on the file icons of the website.
- *
- * <p>
- * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getFileIconRenderer()}.
- * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
- *
- * <p>
- * FileIconRenderer is very suitable when rendering more than one file icon (for instance when rendering a search result where different icons should
- * be displayed for different types of hits) or if you don't want to bother about how to get file icons from the icon repository of the site.
- * </p>
- *
- * <p>
- *  FileIconRenderer has few attributes:
- * </p>
- * <ul>
- *    <li>
- *       <em>icon</em> - The file icon that should be rendered. Default is <code>null</code>. If you try to load a new file icon and it fails,
- *        the previously loaded icon will be cleared (i.e. the renderer will not contain any icon to render).
- *    </li>
- *    <li>
- *       <em>defaultIcon</em> - The fallback file icon that should be rendered if no icon is loaded. Default is <code>null</code>. If you try to
- *       load a new default file icon and it fails, the previously loaded default icon will be cleared (i.e. the renderer will not contain any
- *       default icon to render).
- *    </li>
- *    <li>
- *       <em>useSmallIcons</em> - Whether to use small icons or not <em>(i.e. true == use small icons, false == use large icons)</em>.
- *       Default is <code>true</code>.</li>
- *    <li>
- *       <em>useDescriptions</em> - Whether to render the file icon description or not (i.e. put text in alt attribute of the rendered img
- *       element or not). Default is <code>true</code>.
- *    </li>
- *    <li>
- *       <em>locale</em> - What locale to use when deciding which file icon description to use. Default is the locale of the currently executing
- *       portlet.
- *    </li>
- *    <li>
- *       <em>fontClass</em> - The CSS class to use when rendering (the class attribute of the img element). Default is <code>sv-noborder</code>
- *       (i.e. <code>border-style:none</code>).
- *    </li>
- * </ul>
- *
- * <p>
- * ----------------------------------------------------------------------------------------------------
- * </p>
- *
- * <p>
- *   Using the FileIconRenderer is pretty straightforward, if you remember that it is <strong>stateful</strong> and that previously loaded icons
- *   will be cleared whenever you try to load new ones.
- *   Conceptually you would typically use it like this:
- * </p>
- * <ol>
- *   <li>Get the FileIconRenderer</li>
- *   <li>Possibly init the renderer with rendering settings (locale, useSmallIcons, description)</li>
- *   <li>Possibly load the renderer with a default icon</li>
- *   <li>Load a file icon</li>
- *   <li>Do render</li>
- * </ol>
- * <p>
- * When you have rendered once, you can re-use the FileIconRenderer until you are done. Something like:
- * </p>
- * <ol>
- *   <li>Load a new icon.</li>
- *   <li>Do render.</li>
- * </ol>
- *
- * <p>
- * Loading of an icon can be done using:
- * </p>
- * <ul>
- *    <li>
- *       The file <em>extension</em>.
- *    </li>
- *    <li>
- *       The file <em>uri</em>.
- *    </li>
- *    <li>
- *       The file <em>content type</em>. Note! The term <em>content type</em> is also known as <em>mime type</em>, but since "content type" is
- *       the term typically used by web programmers it is used as terminology in this interface.
- *       <p>
- *          Some information about content type mappings:<br>
- *          A precise file extension (pdf, doc, png etc.) is always needed to extract a file icon from a web site. To enable file icon extraction
- *          via content types, a "content-type-to-extension" mapping will be used. Please be aware that not all content types will be mapped due to
- *          the sheer amount of existing types. Some content types can't be mapped since they doesn't have a single well-defined extension
- *          (a typical example is "application/octet-stream" that is used for a variety of file types, i.e. file extensions).
- *       </p>
- *    </li>
- * </ul>
- * <p>
- * Whenever you try to load the renderer with an icon, the (possibly) previously loaded icon will be cleared.
- * If loading fails, no result will be rendered by default (i.e. an empty string will be the output when calling the render method).
- * If a default icon has been loaded successfully, it will be the output if the renderer contains no icon.
- * <em>(Note that the result of every icon loading is cached for best performance, hence no need for you to do the same in your code.)</em>
- * </p>
- * <p>
- * Please note that all <code>load</code> methods return a boolean! To prevent the boolean to be part of the page output you might in
- * some cases need to do a workaround. <em>The set statement for <code>$ignore</code> in below example demonstrates a simple workaround.</em>
- * </p>
- *
- * <p>
- *    <strong>Example of how this strategy could be implemented in Velocity:</strong><br>
- *    (You want to do a simple listing of all nodes in a collection/iterator "$items" and use FileIconRenderer to render the file icons of all items
- *    that has a configured file icon
- * </p>
- * <pre><code>
- *   <em>## Get PropertyUtil to ease Node property fetching</em>
- *   #set ($propertyUtil = $sitevisionUtils.propertyUtil)
- *
- *   <em>## Get FileIconRenderer</em>
- *   #set ($iconRenderer = $sitevisionUtils.fileIconRenderer)
- *
- *   <em>## Iterate through items and render the names and file icons (if they exist)</em>
- *   &lt;ul style="list-style:none"&gt;
- *   #foreach ($item in $items)
- *      <em>## Try to load the renderer by the item's uri (e.g. "/aPath/aFile.pdf")</em>
- *      #if (!$iconRenderer.loadIconByURI(${propertyUtil.getString($item, 'URI')}))
- *         <em>## If loading failed, try to load the renderer by the item's content type instead (e.g. "application/pdf")</em>
- *         #set ($ignore = $iconRenderer.loadIconByContentType(${propertyUtil.getString($item, 'mimeType')}))
- *      #end
- *
- *      &lt;li&gt;
- *         <em>## Render the name of the node</em>
- *         $propertyUtil.getString($item, 'displayName', '')
- *         <em>## Render the file icon of the node (if no icon was loaded, an empty string will be rendered)</em>
- *         $iconRenderer.render()
- *      &lt;/li&gt;
- *   #end
- *   &lt;/ul&gt;
- * </code></pre>
- *
- * <div style="border:1px dotted gray; padding:10px">
- *    <strong>Tip!</strong> If you use Velocity and call a <code>load</code> method, you must suppress the boolean result so
- *    it doesn't get a part of the rendered output. The above example contains an assignment workaround to suppress the <code>load</code> result:<br>
- *    <pre><code>   #set ($ignore = $iconRenderer.loadIconByContentType(${propertyUtil.getString($item, 'mimeType')}))</code></pre>
- *    This type of workaround can also be achieved via the <code>swallow</code> method of {@link senselogic.sitevision.api.script.ScriptUtil} as:<br>
- *    <pre><code>   $scriptUtil.swallow($iconRenderer.loadIconByContentType(${propertyUtil.getString($item, 'mimeType')}))</code></pre>
- * </div>
- *
- * <p>
- *    Since FileIconRenderer is stateful and likely will be used in Velocity frequently, there are some "shortcuts" that might be useful.
- *    Due to the lack of proper boolean support in Velocity, the boolean attributes has corresponding force/clear methods to set the boolean
- *    to true/false. For example:
- * </p>
- * <ul>
- *   <li>Executing <code>forceUseSmallIcons()</code> results in an execution of <code>setUseSmallIcons(true)</code></li>
- *   <li>Executing <code>clearUseSmallIcons()</code> results in an execution of <code>setUseSmallIcons(false)</code></li>
- * </ul>
- * @author Magnus Lövgren
- * @since Sitevision 2.6.1_08
- */
-
-interface FileIconRenderer {
-  /**
-   * The locale to use when extracting the decription of file icons.
-   * <p>Default is the locale of the currently executing portlet.</p>
-   * <p>
-   *    <strong>Note!</strong> Icons (icon and default icon) that has been loaded with a different locale will be removed whenever an invocation
-   *    of this method changes the locale.
-   * </p>
-   * @param aLocale the locale to use when extracting the icon description
-   */
-  setLocale(aLocale: java.util.Locale): void;
-
-  /**
-   * Which type if file icons (small or large) that should be rendered.
-   * <p>Default is <code>true</code>.</p>
-   * <p>
-   *    <strong>Note!</strong> Icons (icon and default icon) that has been loaded with a different useSmallIcons state will be removed whenever
-   *    an invocation of this method changes the useSmallIcons state.
-   * </p>
-   * @param aUseSmallIcons whether or not to use small icons (<code>true</code> == "use small icons", <code>false</code> == "use large icons")
-   */
-  setUseSmallIcons(aUseSmallIcons: boolean): void;
-
-  /**
-   * Utility method for executing <code>setUseSmallIcons(false)</code>, i.e. "use large icons when rendering".
-   * @see #setUseSmallIcons(boolean)
-   */
-  clearUseSmallIcons(): void;
-
-  /**
-   * Utility method for executing <code>setUseSmallIcons(true)</code>, i.e. "use small icons when rendering".
-   * @see #setUseSmallIcons(boolean)
-   */
-  forceUseSmallIcons(): void;
-
-  /**
-   * If file icon descriptions should be used or not.
-   * <p>Default is <code>true</code>.</p>
-   * <p>Note that file icon descriptions may be locale-dependent, see {@link #setLocale(java.util.Locale)}.</p>
-   * @param aUseDescription whether or not a file icon description should be used when rendering
-   */
-  setUseDescription(aUseDescription: boolean): void;
-
-  /**
-   * Utility method for executing <code>setUseDescription(false)</code>, i.e. "don't use description when rendering".
-   * @see #setUseDescription(boolean)
-   */
-  clearUseDescription(): void;
-
-  /**
-   * Utility method for executing <code>setUseDescription(true)</code>, i.e. "use description when rendering".
-   * @see #setUseDescription(boolean)
-   */
-  forceUseDescription(): void;
-
-  /**
-   * Uses a content type to load the fallback icon that should be used when rendering if no icon is loaded.
-   * @param aContentType the content type (mime type) that decides what file icon to load
-   * @return true if a default file icon was loaded, false if not
-   */
-  loadDefaultIconByContentType(aContentType: java.lang.String): boolean;
-
-  /**
-   * Uses a URI to load the fallback icon that should be used when rendering if no icon is loaded.
-   * <p>
-   * This method tries to extract a file extension from the URI and use that extension to load the default file icon.
-   * If the URI doesn't end with a file extension, default icon loading will fail.
-   * </p>
-   * @param aURI the uri that decides what file icon to load
-   * @return <code>true</code> if a default file icon was loaded, <code>false</code> if not
-   */
-  loadDefaultIconByURI(aURI: java.lang.String): boolean;
-
-  /**
-   * Uses a file extension to load the fallback icon that should be used when rendering if no icon is loaded.
-   * @param aFileExtension the file extension that decides what file icon to load
-   * @return <code>true</code> if a default file icon was loaded, <code>false</code> if not
-   */
-  loadDefaultIconByFileExtension(aFileExtension: java.lang.String): boolean;
-
-  /**
-   * Whether or not a default icon is loaded.
-   * @return <code>true</code> if a default icon is loaded, <code>false</code> if not.
-   */
-  isDefaultIconLoaded(): boolean;
-
-  /**
- * Removes loaded default icon (does nothing if no default icon is loaded)
-  
-    */
-  clearDefaultIcon(): void;
-
-  /**
-   * Uses a content type to load the icon that should be rendered.
-   * @param aContentType the content type (mime type) that decides what file icon to load
-   * @return <code>true</code> if a file icon was loaded, <code>false</code> if not
-   */
-  loadIconByContentType(aContentType: java.lang.String): boolean;
-
-  /**
-   * Uses a URI to load the icon that should be rendered.
-   * <p>
-   * This method tries to extract a file extension from the URI and use that extension to load the icon.
-   * If the URI doesn't end with a file extension, icon loading will fail.
-   * </p>
-   * @param aURI the URI that decides what file icon to load
-   * @return <code>true</code> if a file icon was loaded, <code>false</code> if not
-   */
-  loadIconByURI(aURI: java.lang.String): boolean;
-
-  /**
-   * Uses a URI to load the icon that should be rendered.
-   * @param aFileExtension the file extension that decides what file icon to load
-   * @return <code>true</code> if a file icon was loaded, <code>false</code> if not
-   */
-  loadIconByFileExtension(aFileExtension: java.lang.String): boolean;
-
-  /**
-   * Whether or not an icon is loaded.
-   * @return <code>true</code> if an icon is loaded, <code>false</code> if not.
-   */
-  isIconLoaded(): boolean;
-
-  /**
- * Removes loaded icon (does nothing if no icon is loaded)
-  
-    */
-  clearIcon(): void;
-
-  /**
-   * Sets the CSS class name(-s) to use when rendering.
-   * @param aFontClass the CSS class name(-s) expression. An empty string is equivalent to <code>null</code> - no class attribute will be rendered
-   * @since Sitevision 3.0
-   */
-  setFontClass(aFontClass: java.lang.String): void;
-
-  /**
-   * Removes the CSS class name(-s).
-   * No class attribute will be rendered until a fontClass is set again.
-   * @since Sitevision 3.0
-   */
-  clearFontClass(): void;
-
-  /**
-   * Builds a html img element based on current state.
-   * @return a html img element based on current state, or empty string if no icon and no default icon was loaded
-   */
-  render(): string;
-}