com.tensegrity.gui.swing.dock.core
Class TabEntry

java.lang.Object
  com.tensegrity.gui.swing.dock.core.TabEntry

public final class TabEntry

extends java.lang.Object

Docking framework. This class defines the properties for a single window.

Version:

$Id: TabEntry.java,v 1.2 2005/09/23 09:51:37 sr Exp $

Author:

srutz

Constructor Summary

TabEntry(java.lang.String name, javax.swing.JComponent component)
Constructs a new TabEntry.

Method Summary

javax.swing.Action[]	getActions() Returns the actions.
javax.swing.JComponent	getComponent() Returns the component.
CustomTabTitle	getCustomTabTitle() Returns the currently active custom tab-title or null if none is set.
java.lang.Object	getDescription() Returns the descriptions.
javax.swing.Icon	getIcon() Returns the icon.
java.lang.String	getName() Returns the name.
java.lang.Object	getProperty(java.lang.Object key) Returns a client property
java.util.Collection	getPropertyKeys() Returns all registered property-keys.
java.lang.Object	getUserObject() Returns the user-object.
boolean	isDirty() Returns the dirty flag.
void	putProperty(java.lang.Object key, java.lang.Object value) Puts a client property.
void	setActions(javax.swing.Action[] actions) Sets the actions of this entry.
void	setActionsByName(java.lang.String[] names) Sets the actions for this entry by name.
void	setCustomTabTitle(CustomTabTitle customTabTitle) Sets an optional custom tab-title.
void	setDescription(java.lang.Object description) Sets the description object.
void	setDirty(boolean dirty) Sets the dirty flag.
void	setIcon(javax.swing.Icon icon) Sets the icon.
void	setName(java.lang.String name) Sets the name.
void	setUserObject(java.lang.Object userObject) Sets a user object.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TabEntry

public TabEntry(java.lang.String name,
                javax.swing.JComponent component)

Constructs a new TabEntry.

Parameters:

name - the name for the entry.

component - the component nested inside the entry.

Method Detail

putProperty

public final void putProperty(java.lang.Object key,
                              java.lang.Object value)

Puts a client property.

Parameters:

key - the key of the property.

value - the value of the property.

getProperty

public final java.lang.Object getProperty(java.lang.Object key)

Returns a client property

Parameters:

key - the key of the property.

Returns:

the value of the property or null if it doesn't exist.

getPropertyKeys

public final java.util.Collection getPropertyKeys()

Returns all registered property-keys.

Returns:

all registered property-keys.

setUserObject

public final void setUserObject(java.lang.Object userObject)

Sets a user object.

Parameters:

userObject - the user-object to set.

setActions

public final void setActions(javax.swing.Action[] actions)

Sets the actions of this entry.

Parameters:

actions - the actions of this entry.

setActionsByName

public final void setActionsByName(java.lang.String[] names)

Sets the actions for this entry by name.

Parameters:

names - the names of the actions for this entry.

setDescription

public final void setDescription(java.lang.Object description)

Sets the description object.

Parameters:

description - the description object.

setIcon

public final void setIcon(javax.swing.Icon icon)

Sets the icon.

Parameters:

icon - the icon.

setName

public final void setName(java.lang.String name)

Sets the name.

Parameters:

name - the name.

getName

public final java.lang.String getName()

Returns the name.

Returns:

the name.

getComponent

public final javax.swing.JComponent getComponent()

Returns the component.

Returns:

the component.

getUserObject

public final java.lang.Object getUserObject()

Returns the user-object.

Returns:

the user-object.

getActions

public final javax.swing.Action[] getActions()

Returns the actions.

Returns:

the actions.

getDescription

public final java.lang.Object getDescription()

Returns the descriptions.

Returns:

the descriptions.

getIcon

public final javax.swing.Icon getIcon()

Returns the icon.

Returns:

the icon.

setDirty

public final void setDirty(boolean dirty)

Sets the dirty flag.

Parameters:

dirty - the dirty flag.

isDirty

public final boolean isDirty()

Returns the dirty flag.

Returns:

the dirty flag.

setCustomTabTitle

public void setCustomTabTitle(CustomTabTitle customTabTitle)

Sets an optional custom tab-title.

Parameters:

customTabTitle - the custom tab-title to use.

getCustomTabTitle

public CustomTabTitle getCustomTabTitle()

Returns the currently active custom tab-title or null if none is set.

Returns:

the currently active custom tab-title or null.

toString

public java.lang.String toString()