com.guiseframework.component
Interface ModalFrame<R>

Type Parameters:

R - The type of modal result this modal frame produces.

All Superinterfaces:

Component, CompositeComponent, ContentComponent, DepictedObject, Displayable, Frame, InfoModel, InputFocusableComponent, InputFocusGroupComponent, LabelModel, ModalComponent<Frame.Mode>, Model, PresentationModel, com.globalmentor.beans.PropertyBindable, com.globalmentor.beans.PropertyConstrainable

All Known Implementing Classes:

AbstractModalFrame, DefaultModalFrame

public interface ModalFrame<R>
extends Frame

A frame that supports modal interaction.

Author:

Garret Wilson

Nested Class Summary

Nested classes/interfaces inherited from interface com.guiseframework.component.Frame

Frame.Mode, Frame.State

Field Summary

static java.lang.String	MODAL_PROPERTY The modal state bound property.
static java.lang.String	RESULT_PROPERTY The result bound property.

Fields inherited from interface com.guiseframework.component.Frame

CLOSE_ACTION_CONTROL_PROPERTY, MENU_PROPERTY, MOVABLE_PROPERTY, OPEN_EFFECT_PROPERTY, RELATED_COMPONENT_PROPERTY, RESIZABLE_PROPERTY, STATE_PROPERTY, TITLE_BACKGROUND_COLOR_PROPERTY, TITLE_VISIBLE_PROPERTY, TOOLBAR_PROPERTY

Fields inherited from interface com.guiseframework.component.ContentComponent

CONTENT_PROPERTY

Fields inherited from interface com.guiseframework.component.ModalComponent

MODE_PROPERTY

Fields inherited from interface com.guiseframework.component.InputFocusGroupComponent

INPUT_FOCUS_STRATEGY_PROPERTY, INPUT_FOCUSED_COMPONENT_PROPERTY

Method Summary

R	getResult()
void	setResult(R newResult) Sets the modal result.

Methods inherited from interface com.guiseframework.component.Frame

canClose, close, getCloseActionControl, getCloseActionPrototype, getMenu, getOpenEffect, getRelatedComponent, getState, getTitleBackgroundColor, getToolbar, isModal, isMovable, isResizable, isTitleVisible, open, open, open, setCloseActionControl, setMenu, setModal, setMovable, setOpenEffect, setRelatedComponent, setResizable, setTitleBackgroundColor, setTitleVisible, setToolbar

Methods inherited from interface com.guiseframework.component.ContentComponent

getContent, setContent

Methods inherited from interface com.guiseframework.component.CompositeComponent

addCompositeComponentListener, getChildComponents, hasChildComponents, removeCompositeComponentListener

Methods inherited from interface com.guiseframework.component.ModalComponent

getMode, setMode

Methods inherited from interface com.guiseframework.component.InputFocusGroupComponent

getInputFocusedComponent, getInputFocusStrategy, setInputFocusedComponent, setInputFocusStrategy

Field Detail

MODAL_PROPERTY

static final java.lang.String MODAL_PROPERTY

The modal state bound property.

RESULT_PROPERTY

static final java.lang.String RESULT_PROPERTY

The result bound property.

Method Detail

getResult

R getResult()

Returns:

The result of this frame's modal interaction, or null if no result is given.

setResult

void setResult(R newResult)

Sets the modal result. This is a bound property that only fires a change event when the new value is different via the equals() method.

Parameters:

newResult - The new result of this frame's modal interaction, or null if no result is given.

See Also:

RESULT_PROPERTY