Package org.jppf.ui.options.docking

Class DetachableComponentDescriptor

java.lang.Object

org.jppf.ui.options.docking.DetachableComponentDescriptor

public class DetachableComponentDescriptor
extends Object

Describes the state of a component with regard to the view to which it is attached.

Constructor Summary

Constructors

Constructor	Description
DetachableComponentDescriptor(OptionElement component, Component listenerComponent, Component tabComponent)	Initialize this descriptor.

Method Summary

Modifier and Type	Method	Description
OptionElement	getComponent()	Get the described component.
OptionContainer	getCurrentContainer()	Get the container to which the component is currently attached.
OptionContainer	getInitialContainer()	Get the container to which the component was initially attached.
Component	getListenerComponent()	Get the UI component which has the mouse listener.
Component	getTabComponent()	Get the component displayed in the tab.
String	getViewId()	Get the id of the view in which the component is currently displayed.
void	setCurrentContainer(OptionContainer currentContainer)	Set the container to which the component is currently attached.
void	setListenerComponent(Component listenerComponent)	Set the UI component which has the mouse listener.
void	setViewId(String viewId)	Get the id of the view in which the component is currently displayed.

Methods inherited from class java.lang.Object

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

Constructor Details

DetachableComponentDescriptor

public DetachableComponentDescriptor(OptionElement component,
 Component listenerComponent,
 Component tabComponent)

Initialize this descriptor.

Parameters:

component - the component to describe.

listenerComponent - the UI component which has the mouse listener.

tabComponent - the component displayed in the tab.

Method Details

getComponent

public OptionElement getComponent()

Get the described component.

Returns:

the component as an OptionElement object.

getInitialContainer

public OptionContainer getInitialContainer()

Get the container to which the component was initially attached.

Returns:

the initial container as an OptionContainer object.

getCurrentContainer

public OptionContainer getCurrentContainer()

Get the container to which the component is currently attached.

Returns:

the current container as an OptionContainer object.

setCurrentContainer

public void setCurrentContainer(OptionContainer currentContainer)

Set the container to which the component is currently attached.

Parameters:

currentContainer - the current container as an OptionContainer object.

getViewId

public String getViewId()

Get the id of the view in which the component is currently displayed.

Returns:

the view id as a string.

setViewId

public void setViewId(String viewId)

Get the id of the view in which the component is currently displayed.

Parameters:

viewId - the view id as a string.

getListenerComponent

public Component getListenerComponent()

Get the UI component which has the mouse listener.

Returns:

a Component.

setListenerComponent

public void setListenerComponent(Component listenerComponent)

Set the UI component which has the mouse listener.

Parameters:

listenerComponent - a Component.

getTabComponent

public Component getTabComponent()

Get the component displayed in the tab.

Returns:

a Component.