org.openide.io 1.23.1

org.openide.windows
Interface IOContainer.Provider

Enclosing class:
IOContainer

public static interface IOContainer.Provider

SPI for providers of parent container for IO components (tabs)


Method Summary
 void add(JComponent comp, IOContainer.CallBacks cb)
          Provided component should be added to parent container
 JComponent getSelected()
          Currently selected io component should be returned
 boolean isActivated()
          Checks whether parent container is activated
 boolean isCloseable(JComponent comp)
          Checks whether comp can be closed (e.g.
 void open()
          Parent container for should be opened
 void remove(JComponent comp)
          Provided component should be removed from parent container
 void requestActive()
          Parent container for should be activated
 void requestVisible()
          Parent container for should be selected (if opened)
 void select(JComponent comp)
          Provided component should be selected
 void setIcon(JComponent comp, Icon icon)
          Should set icon for provided component
 void setTitle(JComponent comp, String name)
          Should set title for provided component (e.g.
 void setToolbarActions(JComponent comp, Action[] toolbarActions)
          Should set toolbar actions for provided component
 void setToolTipText(JComponent comp, String text)
          Should set title for provided component (e.g.
 

Method Detail

open

void open()
Parent container for should be opened


requestActive

void requestActive()
Parent container for should be activated


requestVisible

void requestVisible()
Parent container for should be selected (if opened)


isActivated

boolean isActivated()
Checks whether parent container is activated

Returns:
true if activated

add

void add(JComponent comp,
         IOContainer.CallBacks cb)
Provided component should be added to parent container

Parameters:
comp - component to add
cb - callbacks for component notifications or null if component does not need notifications

remove

void remove(JComponent comp)
Provided component should be removed from parent container

Parameters:
comp - component to remove

select

void select(JComponent comp)
Provided component should be selected

Parameters:
comp - component to select

getSelected

JComponent getSelected()
Currently selected io component should be returned

Returns:
currently selected io component or null

setTitle

void setTitle(JComponent comp,
              String name)
Should set title for provided component (e.g. tab title)

Parameters:
comp - component for which title should be set
name - component title

setToolTipText

void setToolTipText(JComponent comp,
                    String text)
Should set title for provided component (e.g. tab title)

Parameters:
comp - component for which title should be set
text - component tool tip text

setIcon

void setIcon(JComponent comp,
             Icon icon)
Should set icon for provided component

Parameters:
comp - component for which icon should set
icon - component icon

setToolbarActions

void setToolbarActions(JComponent comp,
                       Action[] toolbarActions)
Should set toolbar actions for provided component

Parameters:
comp -
toolbarActions - toolbar actions for component

isCloseable

boolean isCloseable(JComponent comp)
Checks whether comp can be closed (e.g. if Close action should be present in component popup menu)

Parameters:
comp - component which should be closeable
Returns:
true if component can be closed

org.openide.io 1.23.1

Built on July 5 2011.  |  Portions Copyright 1997-2011 Sun Microsystems, Inc. All rights reserved.