org.wings.SIcon Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of wings Show documentation

The newest version!

/*
 * Copyright 2000,2005 wingS development team.
 *
 * This file is part of wingS (http://wingsframework.org).
 *
 * wingS is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 *
 * Please see COPYING for the complete licence.
 */
package org.wings;


/**
 * For small fixed size pictures, typically used to decorate components.
 * This icon can be accessed via an URL; this URL is passed to a browser
 * that fetches it from there.
 *
 * @author Henner Zeller
 */
public interface SIcon extends URLResource {
    /**
     * @return the width of the icon, or -1 if unknown.
     */
    int getIconWidth();

    /**
     * @return the height of the icon, or -1 if unknown.
     */
    int getIconHeight();

    /**
     * sets the width of the icon, -1 if unknown.
     */
    void setIconWidth(int width);

    /**
     * sets the height of the icon, -1 if unknown.
     */
    void setIconHeight(int height);

    /**
     * gets the title of the icon, empty String if unknown.
     */
    String getIconTitle();

    /**
     * sets the title of the icon, empty String if unknown.
     */
    void setIconTitle(String title);
}