Package adams.gui.core

Class MultiPagePane.PageContainer

java.lang.Object

adams.gui.core.MultiPagePane.PageContainer

All Implemented Interfaces:

Serializable

Enclosing class:

MultiPagePane

public static class MultiPagePane.PageContainer
extends Object
implements Serializable

Container for page component and title.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected MultiPagePane.DetachablePage	m_DetachablePage	the detachable panel.
protected ImageIcon	m_Icon	the current icon (can be null).
protected Map<String,Object>	m_MetaData	for storing meta-data.
protected Component	m_Page	the page.
protected boolean	m_RemovalAllowed	whether this page can be removed, even if readonly.
protected String	m_Title	the title.

Constructor Summary

Constructors

Constructor	Description
PageContainer(String title, Component page)	Initializes the container with no icon.
PageContainer(String title, Component page, ImageIcon icon)	Initializes the container.

Method Summary

Modifier and Type	Method	Description
MultiPagePane.DetachablePage	getDetachablePage()	Returns the detachable page.
ImageIcon	getIcon()	Returns the icon.
Map<String,Object>	getMetaData()	Returns the meta-data associated with the page.
Component	getPage()	Returns the page.
String	getTitle()	Returns the title.
boolean	isRemovalAllowed()	Returns whether removal is allowed despite read-only pane.
void	setIcon(ImageIcon value)	Sets the icon.
void	setPage(Component value)	Sets the page.
void	setRemovalAllowed(boolean value)	Sets whether removal allowed despite read-only pane.
void	setTitle(String value)	Sets the title.
String	toString()	Just returns the title.

Methods inherited from class java.lang.Object

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

Field Detail

m_Title

protected String m_Title

the title.

m_Page

protected Component m_Page

the page.

m_DetachablePage

protected MultiPagePane.DetachablePage m_DetachablePage

the detachable panel.

m_Icon

protected ImageIcon m_Icon

the current icon (can be null).

m_MetaData

protected Map<String,Object> m_MetaData

for storing meta-data.

m_RemovalAllowed

protected boolean m_RemovalAllowed

whether this page can be removed, even if readonly.

Constructor Detail

PageContainer

public PageContainer(String title,
                     Component page)

Initializes the container with no icon.

Parameters:

title - the title

page - the page

PageContainer

public PageContainer(String title,
                     Component page,
                     ImageIcon icon)

Initializes the container.

Parameters:

title - the title

page - the page

icon - the icon

Method Detail

getTitle

public String getTitle()

Returns the title.

Returns:

the title

setTitle

public void setTitle(String value)

Sets the title.

Parameters:

value - the title

getPage

public Component getPage()

Returns the page.

Returns:

the page

setPage

public void setPage(Component value)

Sets the page.

Parameters:

value - the page

getMetaData

public Map<String,Object> getMetaData()

Returns the meta-data associated with the page.

Returns:

the meta-data

setRemovalAllowed

public void setRemovalAllowed(boolean value)

Sets whether removal allowed despite read-only pane.

Parameters:

value - true if allowed

isRemovalAllowed

public boolean isRemovalAllowed()

Returns whether removal is allowed despite read-only pane.

Returns:

true if allowed

getDetachablePage

public MultiPagePane.DetachablePage getDetachablePage()

Returns the detachable page.

Returns:

the page

toString

public String toString()

Just returns the title.

Overrides:

toString in class Object

Returns:

the title

getIcon

public ImageIcon getIcon()

Returns the icon.

Returns:

the icon

setIcon

public void setIcon(ImageIcon value)

Sets the icon.

Parameters:

value - the icon