com.guiseframework.component
Interface OptionDialogFrame<O>

Type Parameters:

O - The type of options available.

All Superinterfaces:

Component, CompositeComponent, ContentComponent, Control, DepictedObject, DialogFrame<O>, Displayable, Enableable, Frame, InfoModel, InputFocusableComponent, InputFocusGroupComponent, LabelModel, ModalComponent<Frame.Mode>, Model, PresentationModel, com.globalmentor.beans.PropertyBindable, com.globalmentor.beans.PropertyConstrainable, ValueControl<O>, Valued<O>, ValuedComponent<O>, ValueModel<O>

All Known Implementing Classes:

AbstractOptionDialogFrame, MessageOptionDialogFrame, NotificationOptionDialogFrame

public interface OptionDialogFrame<O>
extends DialogFrame<O>

A frame for communication of an option. An option frame defaults to a single composite child panel with a row of options along the bottom. The contents of an option dialog frame should be accessed by getOptionContent() and setOptionContent(Component).

Author:

Garret Wilson

Nested Class Summary

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

Frame.Mode, Frame.State

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

Control.Status

Field Summary

Fields inherited from interface com.guiseframework.component.Frame

CLOSE_ACTION_CONTROL_PROPERTY, MENU_PROPERTY, MODAL_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

Fields inherited from interface com.guiseframework.component.ValueControl

CONVERTER_PROPERTY

Fields inherited from interface com.guiseframework.component.Control

STATUS_PROPERTY

Fields inherited from interface com.guiseframework.model.Enableable

ENABLED_PROPERTY

Fields inherited from interface com.guiseframework.model.ValueModel

VALIDATOR_PROPERTY, VALUE_PROPERTY

Method Summary

Component	getOptionComponent(O option) Returns the component that represents the specified option.
Container	getOptionContainer()
Component	getOptionContent()
java.util.List<O>	getOptions()
void	setOptionContent(Component newOptionContent) Sets the component representing option contents.

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

Methods inherited from interface com.guiseframework.component.Control

getStatus, reset

Methods inherited from interface com.guiseframework.model.Enableable

isEnabled, setEnabled

Methods inherited from interface com.guiseframework.model.ValueModel

clearValue, getDefaultValue, getValidator, getValue, getValueClass, isValidValue, resetValue, setValidator, setValue, validateValue

Methods inherited from interface com.guiseframework.component.ValuedComponent

getValue, getValueClass, setValue

Method Detail

getOptionContent

Component getOptionContent()

Returns:

The component representing option contents, or null if this frame does not have an option contents component.

setOptionContent

void setOptionContent(Component newOptionContent)

Sets the component representing option contents.

Parameters:

newOptionContent - The single option contents component, or null if this frame does not have an option contents component.

getOptionContainer

Container getOptionContainer()

Returns:

The container containing the options.

getOptions

java.util.List<O> getOptions()

Returns:

The read-only list of available options in order.

getOptionComponent

Component getOptionComponent(O option)

Returns the component that represents the specified option.

Parameters:

option - The option for which a component should be returned.

Returns:

The component, such as a button, that represents the given option, or null if there is no component that represents the given option.