org.noos.xing.mydoggy
Interface ContentManagerUI<C extends ContentUI>

All Superinterfaces:

Observable

All Known Subinterfaces:

DesktopContentManagerUI, MultiSplitContentManagerUI, TabbedContentManagerUI<E>

public interface ContentManagerUI<C extends ContentUI>
extends Observable

A ContentManagerUI is an interface to modify the ui behaviours of a content manager. For example this is used to modify the way a content is shown.

Since:

1.1.0

Author:

Angelo De Caro (angelo.decaro@gmail.com)

See Also:

TabbedContentManagerUI, DesktopContentManagerUI

Method Summary

void	addContentManagerUIListener(ContentManagerUIListener listener) Registers listener so that it will receive events when contentUIs are removed or detached.
ContentManagerUIListener[]	getContentManagerUiListener() Returns an array of all the content manager listeners registered on this manager.
C	getContentUI(Content content) Returns the ui part to which this manager maps the specified content.
boolean	isCloseable() Returns the closeable property value.
boolean	isDetachable() Returns the detachable property value.
boolean	isMaximizable() Returns whether this content manager permits the contents to be maximized using the ui.
boolean	isMinimizable() Returns whether this content manager permits the contents to be minimized using the ui.
boolean	isPopupMenuEnabled() Returns whether this content manager permits the popup menu to be shown.
void	removeContentManagerUIListener(ContentManagerUIListener listener) Unregisters listener so that it will no longer receive events.
void	setCloseable(boolean closeable) Set the closeable property.
void	setDetachable(boolean detachable) Set the detachable property.
void	setMaximizable(boolean maximizable) Sets the maximizable property of this manager.
void	setMinimizable(boolean minimizable) Sets the minimizable property of this manager.
void	setPopupMenuEnabled(boolean popupMenuEnabled) Enables or disabled the popup menu for this manager.

Methods inherited from interface org.noos.xing.mydoggy.Observable

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Method Detail

setCloseable

void setCloseable(boolean closeable)

Set the closeable property. All new ContentUI will obtain this value for their closeable property. Furthermore sets the closeable property of all contents already registered to content manager.

Parameters:

closeable - true if all contents can be closed using the ui, false otherwise.

Since:

1.1.0

isCloseable

boolean isCloseable()

Returns the closeable property value.

Returns:

the closeable property value.

Since:

1.4.0

setDetachable

void setDetachable(boolean detachable)

Set the detachable property. All new ContentUI will obtain this value for their detachable property. Furthermore sets the detachable property of all contents already registered to content manager.

Parameters:

detachable - true if all contents can be detached using the ui, false otherwise.

Since:

1.1.0

isDetachable

boolean isDetachable()

Returns the detachable property value.

Returns:

the detachable property value.

Since:

1.4.0

isMaximizable

boolean isMaximizable()

Returns whether this content manager permits the contents to be maximized using the ui.

Returns:

true if this content can be maximized using the ui, false otherwise.

Since:

1.5.0

setMaximizable

void setMaximizable(boolean maximizable)

Sets the maximizable property of this manager.

Parameters:

maximizable - true if this content can be maximized using the ui, false otherwise.

Since:

1.5.0

See Also:

isDetachable()

isMinimizable

boolean isMinimizable()

Returns whether this content manager permits the contents to be minimized using the ui.

Returns:

true if this content can be minimized using the ui, false otherwise.

Since:

1.4.2

setMinimizable

void setMinimizable(boolean minimizable)

Sets the minimizable property of this manager.

Parameters:

minimizable - true if this content can be minimized using the ui, false otherwise.

Since:

1.4.2

See Also:

isDetachable()

setPopupMenuEnabled

void setPopupMenuEnabled(boolean popupMenuEnabled)

Enables or disabled the popup menu for this manager.

Parameters:

popupMenuEnabled -

Since:

1.5.0

isPopupMenuEnabled

boolean isPopupMenuEnabled()

Returns whether this content manager permits the popup menu to be shown.

Returns:

true if the popup menu can be shown, false otherwise.

Since:

1.5.0

getContentUI

C getContentUI(Content content)

Returns the ui part to which this manager maps the specified content.

Parameters:

content - content whose associated ui part is to be returned.

Returns:

the ui part to which this manager maps the specified content.

Since:

1.1.0

addContentManagerUIListener

void addContentManagerUIListener(ContentManagerUIListener listener)

Registers listener so that it will receive events when contentUIs are removed or detached. If listener listener is null, no exception is thrown and no action is performed.

Parameters:

listener - the ContentManagerUIListener to register.

Since:

1.2.0

See Also:

ContentManagerListener

removeContentManagerUIListener

void removeContentManagerUIListener(ContentManagerUIListener listener)

Unregisters listener so that it will no longer receive events. This method performs no function, nor does it throw an exception, if the listener specified by the argument was not previously added to this group. If listener listener is null, no exception is thrown and no action is performed.

Parameters:

listener - the ContentManagerUIListener to be removed

Since:

1.2.0

See Also:

addContentManagerUIListener(ContentManagerUIListener)

getContentManagerUiListener

ContentManagerUIListener[] getContentManagerUiListener()

Returns an array of all the content manager listeners registered on this manager.

Returns:

all of the ContentManagerUI's ContentManagerUIListeners or an empty array if no tool window manager listeners are currently registered.

Since:

1.2.0

See Also:

addContentManagerUIListener(ContentManagerUIListener), removeContentManagerUIListener(ContentManagerUIListener)