Interface Dockable

All Known Subinterfaces: 所有已知子接口：

DockableView , ExplorerWindow , InspectorWindow , LogWindow , NavigatorWindow , PaletteWindow DockableView ， ExplorerWindow ， InspectorWindow ， LogWindow ， NavigatorWindow ， PaletteWindow

All Known Implementing Classes: 所有已知实现类：

DockableWindow DockableWindow

public interface Dockable公共接口可停靠

A Dockable interface.一个可停靠的接口。

The Dockable interface should be implemented by graphical user interfaces that want docking support. Addin developers will typically extend DockableWindow and should not implement Dockable directly.可停靠接口应实施的图形用户界面，要对接支持。加载项开发人员通常会延长DockableWindow ，不应实施Dockable直接。

See Also: 参见：

Docking Package Summary 对接包综述

 

Field Summary 场综述 static int DEFAULT_VISIBILITY_MINIMIZED
Synonym of DEFAULT_VISIBILITY_MINIMIZED同义词DEFAULT_VISIBILITY_MINIMIZED static int DEFAULT_VISIBILITY_RAISED
If the window is tabbed with others, makes this window the active one.如果窗口是标签式与他人，使这个窗口活动之一。 static int DEFAULT_VISIBILITY_VISIBLE
Makes the window visible使窗口可见 static int TYPE_DISCARDABLE
If a Dockable has no corresponding menu View+xxx, it is discardable.如果一个可停靠没有相应的菜单查看+三十，这是discardable。 static int TYPE_GLOBAL_VISIBLE
The visibility of Dockables with this type is determined globally.与此类型确定全球能见度Dockables。 static int TYPE_NO_BUTTONS
does not show buttons in the title bar不显示在标题栏按钮 static int TYPE_NORMAL
If a Dockable has a corresponding menu View+xxx.如果一个可停靠的有一个相应的菜单查看+三十。 static int TYPE_NOT_TABBED
does not allow to be tabbed together with another dockable不允许将标签连同另一停靠 static int TYPE_RECYCLABLE
Recyclable dockables are allowed to change the hosted component.可回收dockables允许改变托管组件。 static int TYPE_TRUNCATE_TITLE
If set, partial titles can be shown in the title bar.如果设置，部分标题可以显示在标题栏中。 Method Summary 方法概述 void addTitleChangeListener ( TitleChangeListener l)
Adds a title change listener to a dockable.添加标题更改侦听到一个可停靠。 int getDefaultVisibility ( Layout layout)
The first time a Dockable is exposed to a layout, if the dockable is not of type TYPE_GLOBAL_VISIBLE , it will be asked if it wants to be shown in that layout.第一次接触到一个可停靠的是一个布局，如果是类型的可停靠不TYPE_GLOBAL_VISIBLE ，它会询问是否要被显示在该布局。 javax.swing.JComponent getHostedComponent ()
Gets the root component of the user interface to be docked or floated.获取用户界面的根组件将停靠或浮动。 int getMenuPreferredMnemonic ()
Gets mnemonic used in the menus of the docking for showing/hiding the dockable.获取对接使用的记忆，在菜单的显示/隐藏停靠。 java.lang.String getMenuTitle ()
Gets the text to display in the menus of the docking for showing/hiding the dockable.获取显示在菜单的显示对接文本/隐藏停靠。 Site getSite ()
Gets the current site where this dockable is docked or floated.获取当前站点停靠在此停靠或浮动。 java.awt.dnd.DropTargetListener getTabDropListener ()
Gets the drop target listener for drop events on the tab.获取下降的标签事件的拖放目标听众。 javax.swing.Icon getTabIcon ()
Gets the icon to display in a tab along side the name.获取的图标显示在路边的名称标签。 java.lang.String getTabName ()
Gets the name to display in a tab.获取的名称显示在一个标签。 java.lang.String getTitleName ()
Gets title to display in a title bar.获取标题显示在标题栏。 int getType ()
Gets the types of dockable accepted by a specific dockable implementation.获取由特定类型的可停靠停靠接纳实施。 java.lang.String getUniqueName ()
Gets a unique name identifying this dockable.获取一个唯一的名称标识此停靠。 void loadLayout ( PropertyAccess p)
reloads the layout information of this dockable.重新载入此停靠布局信息。 void removeTitleChangeListener ( TitleChangeListener l)
Removes the specified title change listener from the dockable.删除指定名称更改侦听从停靠。 void saveLayout ( PropertyAccess p)
Saves the layout information of this dockable.保存此停靠布局信息。 void setSite ( Site site)
Sets the current site where this dockable is docked or floated.集目前这个停靠站点停靠或浮动。

Field Detail 场详细

TYPE_NORMAL TYPE_NORMAL

public static final int TYPE_NORMAL公共静态的最终诠释TYPE_NORMAL 

If a Dockable has a corresponding menu View+xxx.如果一个可停靠的有一个相应的菜单查看+三十。

See Also: 参见：

Constant Field Values 常量字段值

TYPE_DISCARDABLE TYPE_DISCARDABLE

public static final int TYPE_DISCARDABLE公共静态的最终诠释TYPE_DISCARDABLE 

If a Dockable has no corresponding menu View+xxx, it is discardable.如果一个可停靠没有相应的菜单查看+三十，这是discardable。

See Also: 参见：

Constant Field Values 常量字段值

TYPE_RECYCLABLE TYPE_RECYCLABLE

public static final int TYPE_RECYCLABLE公共静态的最终诠释TYPE_RECYCLABLE 

Recyclable dockables are allowed to change the hosted component. When a dock panel is closed, the JComponent of recyclable dockable is removed from the panel.可回收dockables允许改变托管组件。当一个码头面板是封闭的，可停靠JComponent的可回收从小组中删除。 This allows to reuse dockables to re-use previously used dockables. Note that TYPE_DISCARDABLE and TYPE_RECYCLABLE should be exclusive since discardable means that the dockable itself will be removed including the JComponent.这允许重用dockables重新使用以前使用dockables。注意TYPE_DISCARDABLE和TYPE_RECYCLABLE应该是专有的，因为discardable可停靠本身将被删除，包括JComponent的。

See Also: 参见：

Constant Field Values 常量字段值

TYPE_NO_BUTTONS TYPE_NO_BUTTONS

public static final int TYPE_NO_BUTTONS公共静态的最终诠释TYPE_NO_BUTTONS 

does not show buttons in the title bar不显示在标题栏按钮

See Also: 参见：

Constant Field Values 常量字段值

TYPE_NOT_TABBED TYPE_NOT_TABBED

public static final int TYPE_NOT_TABBED公共静态的最终诠释TYPE_NOT_TABBED 

does not allow to be tabbed together with another dockable不允许将标签连同另一停靠

See Also: 参见：

Constant Field Values 常量字段值

TYPE_TRUNCATE_TITLE TYPE_TRUNCATE_TITLE

public static final int TYPE_TRUNCATE_TITLE公共静态的最终诠释TYPE_TRUNCATE_TITLE 

If set, partial titles can be shown in the title bar.如果设置，部分标题可以显示在标题栏中。 If not, the title is not shown at all if there is not enough space.如果没有，标题不显示在所有如果没有足够的空间。

See Also: 参见：

Constant Field Values 常量字段值

TYPE_GLOBAL_VISIBLE TYPE_GLOBAL_VISIBLE

public static final int TYPE_GLOBAL_VISIBLE公共静态的最终诠释TYPE_GLOBAL_VISIBLE 

The visibility of Dockables with this type is determined globally.与此类型确定全球能见度Dockables。 If the user closes the window in one layout, the window will be hidden in every layout.如果用户关闭一个布局窗口，窗口会被隐藏在每一个布局。

See Also: 参见：

Constant Field Values 常量字段值

DEFAULT_VISIBILITY_VISIBLE DEFAULT_VISIBILITY_VISIBLE

public static final int DEFAULT_VISIBILITY_VISIBLE公共静态的最终诠释DEFAULT_VISIBILITY_VISIBLE 

Makes the window visible使窗口可见

See Also: 参见：

getDefaultVisibility(oracle.ide.layout.Layout) , Constant Field Values getDefaultVisibility(oracle.ide.layout.Layout) 常量字段值

DEFAULT_VISIBILITY_MINIMIZED DEFAULT_VISIBILITY_MINIMIZED

public static final int DEFAULT_VISIBILITY_MINIMIZED公共静态的最终诠释DEFAULT_VISIBILITY_MINIMIZED 

Synonym of DEFAULT_VISIBILITY_MINIMIZED同义词DEFAULT_VISIBILITY_MINIMIZED

See Also: 参见：

getDefaultVisibility(oracle.ide.layout.Layout) , Constant Field Values getDefaultVisibility(oracle.ide.layout.Layout) 常量字段值

DEFAULT_VISIBILITY_RAISED DEFAULT_VISIBILITY_RAISED

public static final int DEFAULT_VISIBILITY_RAISED公共静态的最终诠释DEFAULT_VISIBILITY_RAISED 

If the window is tabbed with others, makes this window the active one. The operation is not garanteed if another window in the same tab also wants to be raised.如果窗口是标签式与他人，使这个窗口活动之一。操作不保证，如果同样的标签在另一个窗口也想提高。

See Also: 参见：

getDefaultVisibility(oracle.ide.layout.Layout) , Constant Field Values getDefaultVisibility(oracle.ide.layout.Layout) 常量字段值

getTabName getTabName

public java.lang.String getTabName ()公共java.lang.String getTabName（） 

Gets the name to display in a tab.获取的名称显示在一个标签。

 

Returns: 返回：

the name to display in a tab.该名称显示在一个标签。

See Also: 参见：

getTabIcon()

getTabIcon getTabIcon

public javax.swing.Icon getTabIcon ()公共javax.swing.Icon getTabIcon（） 

Gets the icon to display in a tab along side the name.获取的图标显示在路边的名称标签。

 

Returns: 返回：

the the icon to display in a tab.该图标以显示在一个标签。

See Also: 参见：

getTabName()

getTitleName getTitleName

public java.lang.String getTitleName ()公共java.lang.String getTitleName（） 

Gets title to display in a title bar.获取标题显示在标题栏。

 

Returns: 返回：

the title to display in a title bar.标题中显示标题栏。

See Also: 参见：

getTabIcon()

getUniqueName getUniqueName

public java.lang.String getUniqueName ()公共java.lang.String getUniqueName（） 

Gets a unique name identifying this dockable.获取一个唯一的名称标识此停靠。 This name is used to register the dockable in the DockingRegistry.此名称用于注册DockingRegistry停靠在。 In general, the unique name should be generated by using the fully qualified name of the class implementing a dockable and adding an instance counter to that name.在一般情况下，应生成唯一的名称使用的类的完全限定名称实施一个可停靠的一个实例并添加计数器到该名称。

 

Returns: 返回：

a unique name used for registration purposes.一个唯一的名称引用为注册目的。

getType getType

public int getType ()公众诠释getType（） 

Gets the types of dockable accepted by a specific dockable implementation. The constants above define some standard types.获取类型的可停靠的执行情况接受了一个特定的停靠。以上的常量定义一些标准类型。 These types can be OR(ed) together.这些类型可以是或（ED）的合作。

 

Returns: 返回：

the type accepted by this dockable implementation.执行此停靠接受的类型。

getSite getSite

public Site getSite ()公共网站 getSite（） 

Gets the current site where this dockable is docked or floated. Implementors just need to provide a data member to hold the incoming site.获取当前站点停靠在此停靠或浮动。实现者只需要提供一个数据成员来保存传入的站点。

 

Returns: 返回：

the current site.目前网站。

See Also: 参见：

setSite(oracle.ide.docking.Site)

setSite setSite

public void setSite ( Site site)公共无效setSite（ 网站站点） 

Sets the current site where this dockable is docked or floated. Implementors just need to provide a data member to hold the incoming site.目前设置在此停靠站点停靠或浮动。实现者只需要提供一个数据成员来保存传入的站点。

 

Parameters: 参数：

site - the site to set. site -站点设置。

See Also: 参见：

getSite()

getHostedComponent getHostedComponent

public javax.swing.JComponent getHostedComponent ()公共javax.swing.JComponent getHostedComponent（） 

Gets the root component of the user interface to be docked or floated.获取用户界面的根组件将停靠或浮动。

 

Returns: 返回：

the root component.根组件。

addTitleChangeListener addTitleChangeListener

public void addTitleChangeListener ( TitleChangeListener l)公共无效addTitleChangeListener（ TitleChangeListener升） 

Adds a title change listener to a dockable.添加标题更改侦听到一个可停靠。 TitleChangeEvents should be trigger by a dockable whenever their title information changes. TitleChangeEvents应引发一个可停靠的信息发生变化时的标题。

 

Parameters: 参数：

l - a TitleChangeListener instance. l - 1 TitleChangeListener实例。

removeTitleChangeListener removeTitleChangeListener

public void removeTitleChangeListener ( TitleChangeListener l)公共无效removeTitleChangeListener（ TitleChangeListener升） 

Removes the specified title change listener from the dockable.删除指定名称更改侦听从停靠。

 

Parameters: 参数：

l - a TitleChangeListener instance. l - 1 TitleChangeListener实例。

saveLayout saveLayout

public void saveLayout ( PropertyAccess p)公共无效saveLayout（ PropertyAccess规划） 

Saves the layout information of this dockable.保存此停靠布局信息。

 

Parameters: 参数：

p - the storage object p -存储对象

loadLayout loadLayout

public void loadLayout ( PropertyAccess p)公共无效loadLayout（ PropertyAccess规划） 

reloads the layout information of this dockable.重新载入此停靠布局信息。

 

Parameters: 参数：

p - the storage object p -存储对象

getTabDropListener getTabDropListener

public java.awt.dnd.DropTargetListener getTabDropListener ()公共java.awt.dnd.DropTargetListener getTabDropListener（） 

Gets the drop target listener for drop events on the tab.获取下降的标签事件的拖放目标听众。 The TitledPanel will forward drop events to the appropriate listener for each tab.该TitledPanel会把下降到适当的事件监听器的每个标签。

If handling drop events on the tab is not necessary, the implementation of this method should return null.如果在标签处理的事件是没有必要下降，该方法执行本应该返回null。

Note that this method may called repeatedly during a drag and drop operation, so it should be fast.请注意，此方法可能会一再呼吁在一个操作拖放，所以应该是快。

 

Returns: 返回：

the drop target listener下降的目标听众

getMenuTitle getMenuTitle

public java.lang.String getMenuTitle ()公共java.lang.String getMenuTitle（） 

Gets the text to display in the menus of the docking for showing/hiding the dockable.获取显示在菜单的显示对接文本/隐藏停靠。

 

Returns: 返回：

the string to display in the menu字符串显示在菜单

getMenuPreferredMnemonic getMenuPreferredMnemonic

public int getMenuPreferredMnemonic ()公众诠释getMenuPreferredMnemonic（） 

Gets mnemonic used in the menus of the docking for showing/hiding the dockable.获取对接使用的记忆，在菜单的显示/隐藏停靠。

 

Returns: 返回：

the mnemonic的记忆

getDefaultVisibility getDefaultVisibility

public int getDefaultVisibility ( Layout layout)公众诠释getDefaultVisibility（ 布局布局） 

The first time a Dockable is exposed to a layout, if the dockable is not of type TYPE_GLOBAL_VISIBLE , it will be asked if it wants to be shown in that layout.第一次接触到一个可停靠的是一个布局，如果是类型的可停靠不TYPE_GLOBAL_VISIBLE ，它会询问是否要被显示在该布局。

 

Parameters: 参数：

layout - layout -