org.openide.windows

Class IOTab

java.lang.Object

org.openide.windows.IOTab

public abstract class IOTab
extends Object

Settings of tool tip/icon for IO component (tab).

Client usage:

  // settings of IO tab icon, tooltip
  InputOutput io = ...;
  Icon icon = ...;
  IOTab.setIcon(io, icon);
  IOTab.setToolTipText(io, "text");
 

How to support IOTab in own IOProvider implementation:

• InputOutput provided by IOProvider has to implement Lookup.Provider
• Extend IOTab and implement its abstract methods
• Place instance of IOTab to Lookup provided by InputOutput

Since:

1.15

Constructor Summary

Constructors

Constructor and Description
IOTab()

Method Summary

Modifier and Type	Method and Description
protected abstract Icon	getIcon() Gets current tab icon
static Icon	getIcon(InputOutput io) Gets current tab icon for specified IO
protected abstract String	getToolTipText() Gets current tool tip text
static String	getToolTipText(InputOutput io) Gets current tool tip text for specified IO
static boolean	isSupported(InputOutput io) Checks whether this feature is supported for provided IO
protected abstract void	setIcon(Icon icon) Sets icon to tab
static void	setIcon(InputOutput io, Icon icon) Sets icon to tab corresponding to specified IO
static void	setToolTipText(InputOutput io, String text) Sets tool tip text to tab corresponding to specified IO
protected abstract void	setToolTipText(String text) Sets tool tip text to tab

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IOTab

public IOTab()

Method Detail

getIcon

public static Icon getIcon(InputOutput io)

Gets current tab icon for specified IO

Parameters:

io - IO to operate on

Returns:

current tab icon or null if not supported

setIcon

public static void setIcon(InputOutput io,
                           Icon icon)

Sets icon to tab corresponding to specified IO

Parameters:

io - IO to operate on

icon - tab icon

getToolTipText

public static String getToolTipText(InputOutput io)

Gets current tool tip text for specified IO

Parameters:

io - IO to operate on

Returns:

current tool tip text or null if not supported

setToolTipText

public static void setToolTipText(InputOutput io,
                                  String text)

Sets tool tip text to tab corresponding to specified IO

Parameters:

io - IO to operate on

text - new tool tip text

isSupported

public static boolean isSupported(InputOutput io)

Checks whether this feature is supported for provided IO

Parameters:

io - IO to check on

Returns:

true if supported

getIcon

protected abstract Icon getIcon()

Gets current tab icon

Returns:

current tab icon

setIcon

protected abstract void setIcon(Icon icon)

Sets icon to tab

Parameters:

icon - tab icon

getToolTipText

protected abstract String getToolTipText()

Gets current tool tip text

Returns:

current tool tip text

setToolTipText

protected abstract void setToolTipText(String text)

Sets tool tip text to tab

Parameters:

text - new tool tip text