org.noos.xing.mydoggy.DesktopContentUI Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mydoggy-api

MyDoggy-Api contains the application program interface of MyDoggy to manage every aspects of the framework.

There is a newer version: 1.6.0

package org.noos.xing.mydoggy;

import java.awt.*;

/**
 * This interface let you modify ui behaviours of a content when a DesktopContentManagerUI is used
 * as current ContentManagerUI.
 *
 * @author Angelo De Caro ([email protected])
 * @since 1.1.0
 * @see DesktopContentManagerUI
 */
public interface DesktopContentUI extends ContentUI {

    /**
     * Sets the content frame location.
     * The top-left corner of the new location
     * is specified by the x and y
     * parameters in the system coordinate space.
     *
     * @param x the x-coordinate of the new location's
     *          top-left corner in the system's coordinate space
     * @param y the y-coordinate of the new location's
     *          top-left corner in the system's coordinate space
     * @see #getLocation
     * @since 1.1.0
     */
    void setLocation(int x, int y);

    /**
     * Gets the location of the content frame in the form of a
     * point specifying the component's top-left corner.
     * The location will be relative to the system coordinate space.
     *
     * @return an instance of Point representing the top-left corner of the component's bounds in
     *         the system coordinate space.
     * @see #setLocation
     * @since 1.1.0
     */
    Point getLocation();

    /**
     * Sets the content frame size.
     *
     * @param width  the new width of this component in pixels
     * @param height the new height of this component in pixels
     * @see #getSize
     * @since 1.1.0
     */
    void setSize(int width, int height);

    /**
     * Returns the size of the content frame in the form of a
     * Dimension object. The height
     * field of the Dimension object contains
     * this content frame's height, and the width
     * field of the Dimension object contains
     * this content frame's width.
     *
     * @return a Dimension object that indicates the
     *         size of this content frame.
     * @see #setSize
     * @since 1.1.0
     */
    Dimension getSize();

    /**
     * Returns whether the DesktopContentUI is currently iconified.
     *
     * @return true if this content frame is iconified
     * @see #setIconified(boolean)
     * @since 1.1.0
     */
    boolean isIconified();

    /**
     * Iconifies or de-iconifies this content frame,
     *
     * @param iconified a boolean, where true means to iconify this content frame and
     *                  false means to de-iconify it.
     * @see #isIconified()
     * @since 1.1.0
     */
    void setIconified(boolean iconified);

}