org.noos.xing.mydoggy.RepresentativeAnchorDescriptor Maven / Gradle / Ivy
Go to download
MyDoggy-Api contains the application program interface of MyDoggy to manage every aspects of the framework.
The newest version!
package org.noos.xing.mydoggy;
import javax.swing.*;
/**
* This interface is used to modify the behaviour of a representative anchor.
*
* @author Angelo De Caro ([email protected])
* @since 1.5.0
*/
public interface RepresentativeAnchorDescriptor extends Observable {
/**
* Returns the descriptor owner.
* @return the dockable which owns this descriptor.
* @since 1.5.0
*/
D getDockable();
/**
*
* @return
*/
ToolWindowAnchor getAnchor();
/**
* Enable or disable the representative anchor button. The method throw an exception when it is called
* on a tool whose type is FLOATING_FREE.
*
* @param visible true to enable make visible the representative anchor button, false otherwise.
* @since 1.5.0
*/
void setVisible(boolean visible);
/**
* Returns true if the representative anchor button is visible, false otherwise.
*
* @return true if the representative anchor button is visible, false otherwise.
* @since 1.5.0
*/
boolean isVisible();
/**
* Sets the title of the representative anchor.
*
* @param title the new title of the representative anchor.
* @since 1.5.0
*/
void setTitle(String title);
/**
* Returns the current title.
*
* @return the current title.
* @since 1.5.0
*/
String getTitle();
/**
* Sets the icon of the representative anchor.
*
* @param icon the new icon of the representative anchor.
* @since 1.5.0
*/
void setIcon(Icon icon);
/**
* Returns the current icon.
*
* @return the current icon.
* @since 1.5.0
*/
Icon getIcon();
/**
* Sets the preview mode. If the preview mode is enabled then when the mouse waits
* on the toolwindow representative button after a delay time the preview will become visible.
*
* @param enabled true to enable preview mode;
* false to disable preview mode.
* @see #isPreviewEnabled()
* @since 1.5.0
*/
void setPreviewEnabled(boolean enabled);
/**
* Returns the preview mode status.
*
* @return true if the preview mode is enabled;
* false otherwise.
* @see #setPreviewEnabled(boolean)
* @since 1.5.0
*/
boolean isPreviewEnabled();
/**
* Sets the preview delay. When the mouse waits on the toolwindow representative button
* after a delay time the preview will become visible if the preview mode is enabled.
*
* @param delay the preview delay
* @see #getPreviewDelay()
* @since 1.5.0
*/
void setPreviewDelay(int delay);
/**
* Returns the preview delay.
*
* @return preview delay in milliseconds.
* @see #setPreviewDelay(int)
* @since 1.5.0
*/
int getPreviewDelay();
/**
* Sets the transparent ratio of the preview. Valid range is [0.0, 1.0]
*
* @param transparentRatio the transparent ratio.
* @see #getPreviewTransparentRatio()
* @since 1.5.0
*/
void setPreviewTransparentRatio(float transparentRatio);
/**
* Returns the transparent ratio.
*
* @return ratio value used to describe the opacity of the preview.
* @see #setPreviewTransparentRatio(float)
* @since 1.5.0
*/
float getPreviewTransparentRatio();
/**
* Add an anchor used to indicate where the dockable can be placed.
*
* @param anchor an anchor used to indicate where the dockable can be placed.
* @since 1.5.0
*/
void addLockingAnchor(ToolWindowAnchor anchor);
/**
* Remove an anchor to indicate where the dockable cannot be placed.
*
* @param anchor an anchor to indicate where the dockable cannot be placed.
* @since 1.5.0
*/
void removeLockingAnchor(ToolWindowAnchor anchor);
/**
* Remove all anchors so the dockable can stay only in the current position
*
* @since 1.5.0
*/
void removeAllLockingAnchor();
/**
* Returns the anchors register as locking anchors.
*
* @return the anchors register as locking anchors.
* @since 1.5.0
*/
ToolWindowAnchor[] getLockingAnchors();
/**
* Checks if the specified anchor is registered as a locking anchor.
*
* @param anchor the anchor whose presence must be checked.
* @return true if the anchor is present, false otherwise.
* @since 1.5.0
*/
boolean containsLockingAnchor(ToolWindowAnchor anchor);
/**
* Ensure that the representative anchor is visible to the user.
*
* @since 1.5.0
*/
void ensureVisible();
/**
* Show a message near the representative anchor.
*
* @param icon an icon.
* @param message the message to be shown.
* @since 1.5.0
*/
void showMessage(Icon icon, String message);
}