Package io.guise.framework.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, com.globalmentor.model.MutableValued<O>, PresentationModel, com.globalmentor.beans.PropertyBindable, com.globalmentor.beans.PropertyConstrainable, ValueControl<O>, com.globalmentor.model.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

  • Method Details

    • 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

      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.