org.noos.xing.mydoggy
Enum ToolWindowType

java.lang.Object
  java.lang.Enum<ToolWindowType>
      org.noos.xing.mydoggy.ToolWindowType

All Implemented Interfaces:

Serializable, Comparable<ToolWindowType>

public enum ToolWindowType
extends Enum<ToolWindowType>

Every tool window has a type that specifies the visual behaviours of the tool.

Since:

1.0.0

Author:

Angelo De Caro (angelo.decaro@gmail.com)

Enum Constant Summary

DOCKED
When DOCKED type is used, the tool window shares frame space and fixes to a docking area along one of the tool window bars (the one containing the corresponding anchor button).

EXTERN
When a toolwindow is added to another tool as a tab, that tool acquire this type.

FLOATING
This type enables a tool window to be detached from the main window frame.

FLOATING_FREE
This type differs from FLOATING type for the absence of the representative button on the tool window bar.

FLOATING_LIVE
This type enables a tool to be floating in the frame rather than having floating windows "out of the frame".

SLIDING
When SLIDING type is used, the tool window overlaps the main frame and/or other tool windows.

Method Summary

static ToolWindowType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ToolWindowType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DOCKED

public static final ToolWindowType DOCKED

When DOCKED type is used, the tool window shares frame space and fixes to a docking area along one of the tool window bars (the one containing the corresponding anchor button).

Since:

1.0.0

See Also:

DockedTypeDescriptor

SLIDING

public static final ToolWindowType SLIDING

When SLIDING type is used, the tool window overlaps the main frame and/or other tool windows. When it loses focus, the tool window hides itself.

Since:

1.0.0

FLOATING

public static final ToolWindowType FLOATING

This type enables a tool window to be detached from the main window frame. When Floating type is used, the tool window detaches to the position where it was last floated (or screen center or location setted for toolwindow's FloatingTypeDescriptor, if never before floated)

Since:

1.0.0

See Also:

FloatingTypeDescriptor

FLOATING_FREE

public static final ToolWindowType FLOATING_FREE

This type differs from FLOATING type for the absence of the representative button on the tool window bar.

Since:

1.0.0

See Also:

ToolWindowAnchor

FLOATING_LIVE

public static final ToolWindowType FLOATING_LIVE

This type enables a tool to be floating in the frame rather than having floating windows "out of the frame".

Since:

1.4.0

See Also:

FloatingLiveTypeDescriptor

EXTERN

public static final ToolWindowType EXTERN

When a toolwindow is added to another tool as a tab, that tool acquire this type. The user cannot set directly this type.

Since:

1.4.0

See Also:

ToolWindow.addToolWindowTab(Dockable)

Method Detail

values

public static ToolWindowType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ToolWindowType c : ToolWindowType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ToolWindowType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null