net.sf.mmm.client.ui.api.feature

Interface UiFeatureOpenClose

All Superinterfaces:

AttributeReadVisible, AttributeWriteVisible, UiFeature

All Known Subinterfaces:

UiWidgetAbstractDialogWindow, UiWidgetPopup, UiWidgetWindow

All Known Implementing Classes:

AbstractUiWidgetAbstractDialogWindow, AbstractUiWidgetPopup, AbstractUiWidgetWindow, UiWidgetCustomAbstractDialogWindow, UiWidgetCustomPopup, UiWidgetPopupGwt, UiWidgetPopupTestImpl, UiWidgetWindowGwt

public interface UiFeatureOpenClose
extends UiFeature, AttributeWriteVisible

This is the interface for the features of an object (e.g. a window) that can be opened and closed. It allows to add and remove instances of close handlers as well as open handlers.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
void	addCloseHandler(UiHandlerEventClose handler) This method adds the given UiHandlerEventClose to this object.
void	addOpenHandler(UiHandlerEventOpen handler) This method adds the given UiHandlerEventOpen to this object.
void	close() Closes this object so it gets hidden.
void	open() Opens this object so it gets visible.
boolean	removeCloseHandler(UiHandlerEventClose handler) This method removes the given UiHandlerEventClose from this object.
boolean	removeOpenHandler(UiHandlerEventOpen handler) This method removes the given UiHandlerEventOpen from this object.

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteVisible

setVisible

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadVisible

isVisible

Method Detail

open

void open()

Opens this object so it gets visible. Has the same effect as setVisible(true).

close

void close()

Closes this object so it gets hidden. Has the same effect as setVisible(false).

addOpenHandler

void addOpenHandler(UiHandlerEventOpen handler)

This method adds the given UiHandlerEventOpen to this object.

Parameters:

handler - is the UiHandlerEventOpen to add.

addCloseHandler

void addCloseHandler(UiHandlerEventClose handler)

This method adds the given UiHandlerEventClose to this object.

Parameters:

handler - is the UiHandlerEventClose to add.

removeOpenHandler

boolean removeOpenHandler(UiHandlerEventOpen handler)

This method removes the given UiHandlerEventOpen from this object.

Parameters:

handler - is the UiHandlerEventClose to remove.

Returns:

true if the handler has been removed successfully, false if it was NOT registered and nothing has changed.

removeCloseHandler

boolean removeCloseHandler(UiHandlerEventClose handler)

This method removes the given UiHandlerEventClose from this object.

Parameters:

handler - is the UiHandlerEventClose to remove.

Returns:

true if the handler has been removed successfully, false if it was NOT registered and nothing has changed.