Package io.guise.framework.component

Class AbstractDialogFrame<V>

java.lang.Object
com.globalmentor.beans.BoundPropertyObject
io.guise.framework.event.GuiseBoundPropertyObject
io.guise.framework.model.ui.AbstractPresentationModel
io.guise.framework.component.AbstractComponent
io.guise.framework.component.AbstractCompositeComponent
io.guise.framework.component.AbstractMultipleCompositeComponent
io.guise.framework.component.AbstractArrayCompositeComponent
io.guise.framework.component.AbstractEnumCompositeComponent<AbstractFrame.FrameComponent>
io.guise.framework.component.AbstractFrame
io.guise.framework.component.AbstractDialogFrame<V>
Type Parameters:
V - The value to be communicated.
All Implemented Interfaces:
com.globalmentor.beans.PropertyBindable, com.globalmentor.beans.PropertyConstrainable, com.globalmentor.model.MutableValued<V>, com.globalmentor.model.Valued<V>, io.clogr.Clogged, Component, CompositeComponent, ContentComponent, Control, DialogFrame<V>, Frame, InputFocusableComponent, InputFocusGroupComponent, ModalComponent<Frame.Mode>, ValueControl<V>, ValuedComponent<V>, Displayable, Enableable, InfoModel, LabelModel, Model, PresentationModel, ValueModel<V>, DepictedObject
Direct Known Subclasses:
AbstractOptionDialogFrame, CalendarDialogFrame, DefaultDialogFrame
public abstract class AbstractDialogFrame<V> extends AbstractFrame implements DialogFrame<V>
Abstract implementation of a frame meant for communication of a value. A dialog frame by default is modal and movable but not resizable. The component valid status is updated before a change in the ValueModel.VALUE_PROPERTY or the ValueModel.VALIDATOR_PROPERTY is fired.

This implementation binds the action AbstractFrame.getCloseActionPrototype() to the command ProcessCommand.CONTINUE.

Author:
Garret Wilson

  • Constructor Details

    • AbstractDialogFrame

      public AbstractDialogFrame(ValueModel<V> valueModel, Component component)
      Value model, and component constructor.
      Parameters:
      valueModel - The frame value model.
      component - The single child component, or null if this frame should have no child component.
      Throws:
      NullPointerException - if the given value model is null.

  • Method Details

    • getValueModel

      protected ValueModel<V> getValueModel()
      Returns:
      The value model used by this component.

    • isEnabled

      public boolean isEnabled()
      Specified by:
      isEnabled in interface Enableable
      Returns:
      Whether the object is enabled and can receive user input.

    • setEnabled

      public void setEnabled(boolean newEnabled)
      Description copied from interface: Enableable
      Sets whether the object is enabled and can receive user input. This is a bound property of type Boolean.
      Specified by:
      setEnabled in interface Enableable
      Parameters:
      newEnabled - true if the object should indicate and accept user input.
      See Also:

    • getStatus

      public Control.Status getStatus()
      Specified by:
      getStatus in interface Control
      Returns:
      The status of the current user input, or null if there is no status to report.

    • setStatus

      protected void setStatus(Control.Status newStatus)
      Sets the status of the current user input. This is a bound property.
      Parameters:
      newStatus - The new status of the current user input, or null if there is no status to report.
      See Also:

    • updateStatus

      protected void updateStatus()
      Rechecks user input status of this component, and updates the status.
      See Also:

    • determineStatus

      protected Control.Status determineStatus()
      Checks the user input status of the control. If the component has a notification of Notification.Severity.WARN, the status is determined to be Control.Status.WARNING. If the component has a notification of Notification.Severity.ERROR, the status is determined to be Control.Status.ERROR. Otherwise, this version returns null.
      Returns:
      The current user input status of the control.

    • updateValid

      protected void updateValid()
      Rechecks user input validity of this component and all child components, and updates the valid state. This implementation only updates the valid property if the property is already initialized or there is at least one listener to the Component.VALID_PROPERTY.

      This version also updates the status.

      Overrides:
      updateValid in class AbstractComponent
      See Also:

    • setNotification

      public void setNotification(Notification newNotification)
      Sets the component notification. This is a bound property. The notification is also fired as a NotificationEvent on this component if a new notification is given. Parents are expected to refire the notification event up the hierarchy.

      This version updates the component status if the notification changes.

      Specified by:
      setNotification in interface Component
      Overrides:
      setNotification in class AbstractComponent
      Parameters:
      newNotification - The notification for the component, or null if no notification is associated with this component.
      See Also:

    • reset

      public void reset()
      Resets the control to its default value.

      This version clears any notification and resets the control value.

      Specified by:
      reset in interface Control
      See Also:

    • firePropertyChange

      protected <VV> void firePropertyChange(String propertyName, VV oldValue, VV newValue)

      This version first updates the valid status if the value is reported as being changed.

      Overrides:
      firePropertyChange in class com.globalmentor.beans.BoundPropertyObject

    • determineValid

      protected boolean determineValid()
      Checks the state of the component for validity. This version returns true.

      This version calls AbstractCompositeComponent.determineChildrenValid().

      This version checks the validity of the value model.

      Overrides:
      determineValid in class AbstractCompositeComponent
      Returns:
      true if the component and all children passes all validity tests, else false.

    • validate

      public boolean validate()
      Validates the user input of this component and all child components. The component will be updated with error information.

      This version clears all notifications. This version calls AbstractComponent.updateValid().

      This version first calls AbstractCompositeComponent.validateChildren() so that all children will be validated before checks are performed on this component.

      This version validates the associated value model.

      Specified by:
      validate in interface Component
      Overrides:
      validate in class AbstractFrame
      Returns:
      The current state of Component.isValid() as a convenience.

    • getDefaultValue

      public V getDefaultValue()
      Specified by:
      getDefaultValue in interface ValueModel<V>
      Returns:
      The default value.

    • getValue

      public V getValue()
      Specified by:
      getValue in interface com.globalmentor.model.Valued<V>
      Specified by:
      getValue in interface ValuedComponent<V>
      Specified by:
      getValue in interface ValueModel<V>
      Returns:
      The input value, or null if there is no input value.

    • setValue

      public void setValue(V newValue) throws PropertyVetoException
      Description copied from interface: ValueModel
      Sets the new value. This is a bound property that only fires a change event when the new value is different via the equals() method. If a validator is installed, the value will first be validated before the current value is changed. Validation always occurs if a validator is installed, even if the value is not changing. If the value change is vetoed by the installed validator, the validation exception will be accessible via Throwable.getCause().
      Specified by:
      setValue in interface com.globalmentor.model.MutableValued<V>
      Specified by:
      setValue in interface ValuedComponent<V>
      Specified by:
      setValue in interface ValueModel<V>
      Parameters:
      newValue - The new value.
      Throws:
      PropertyVetoException - if the provided value is not valid or the change has otherwise been vetoed.
      See Also:

    • clearValue

      public void clearValue()
      Description copied from interface: ValueModel
      Clears the value by setting the value to null, which may be invalid according to any installed validators. No validation occurs.
      Specified by:
      clearValue in interface ValueModel<V>
      See Also:

    • resetValue

      public void resetValue()
      Description copied from interface: ValueModel
      Resets the value to a default value, which may be invalid according to any installed validators. No validation occurs.
      Specified by:
      resetValue in interface ValueModel<V>
      See Also:

    • getValidator

      public Validator<V> getValidator()
      Specified by:
      getValidator in interface ValueModel<V>
      Returns:
      The validator for this model, or null if no validator is installed.

    • setValidator

      public void setValidator(Validator<V> newValidator)
      Description copied from interface: ValueModel
      Sets the validator. This is a bound property
      Specified by:
      setValidator in interface ValueModel<V>
      Parameters:
      newValidator - The validator for this model, or null if no validator should be used.
      See Also:

    • isValidValue

      public boolean isValidValue()
      Description copied from interface: ValueModel
      Determines whether the value of this model is valid.
      Specified by:
      isValidValue in interface ValueModel<V>
      Returns:
      Whether the value of this model is valid.

    • validateValue

      public void validateValue() throws ValidationException
      Description copied from interface: ValueModel
      Validates the value of this model, throwing an exception if the model is not valid.
      Specified by:
      validateValue in interface ValueModel<V>
      Throws:
      ValidationException - if the value of this model is not valid.

    • getValueClass

      public Class<V> getValueClass()
      Specified by:
      getValueClass in interface ValuedComponent<V>
      Specified by:
      getValueClass in interface ValueModel<V>
      Returns:
      The class representing the type of value this model can hold.