com.guiseframework.component
Class AbstractLayoutControl

java.lang.Object
  com.globalmentor.beans.BoundPropertyObject
      com.guiseframework.event.GuiseBoundPropertyObject
          com.guiseframework.model.ui.AbstractPresentationModel
              com.guiseframework.component.AbstractComponent
                  com.guiseframework.component.AbstractCompositeComponent
                      com.guiseframework.component.AbstractMultipleCompositeComponent
                          com.guiseframework.component.AbstractListCompositeComponent
                              com.guiseframework.component.AbstractLayoutComponent
                                  com.guiseframework.component.AbstractLayoutControl

All Implemented Interfaces:

com.globalmentor.beans.PropertyBindable, com.globalmentor.beans.PropertyConstrainable, Component, CompositeComponent, Control, InputFocusableComponent, LayoutComponent, LayoutControl, Displayable, Enableable, InfoModel, LabelModel, Model, PresentationModel, DepictedObject

Direct Known Subclasses:

AbstractLayoutValueControl

public abstract class AbstractLayoutControl
extends AbstractLayoutComponent
implements LayoutControl

An abstract implementation of a layout component that is also a control.

Author:

Garret Wilson

Nested Class Summary

Nested classes/interfaces inherited from class com.guiseframework.component.AbstractComponent

AbstractComponent.AbstractFlyoverFrameStrategy<S extends Component>, AbstractComponent.AbstractFlyoverStrategy<S extends Component>, AbstractComponent.DefaultFlyoverStrategy<S extends Component>

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

Control.Status

Field Summary

Fields inherited from class com.globalmentor.beans.BoundPropertyObject

NO_PROPERTY_CHANGE_LISTENERS, NO_VETOABLE_CHANGE_LISTENERS

Fields inherited from interface com.guiseframework.component.LayoutComponent

LAYOUT_PROPERTY, LAYOUT_THEME_APPLIED_PROPERTY

Fields inherited from interface com.guiseframework.component.Control

STATUS_PROPERTY

Fields inherited from interface com.guiseframework.model.Enableable

ENABLED_PROPERTY

Constructor Summary

AbstractLayoutControl(InfoModel infoModel, Enableable enableable, Layout<?> layout)
Info model, enableable, and layout constructor.

AbstractLayoutControl(Layout<?> layout)
Layout constructor with a default info model and enableable.

Method Summary

protected Control.Status	determineStatus() Checks the user input status of the control.
protected void	enabledPropertyChange(boolean oldValue, boolean newValue) Called when the enabled property changes.
protected Enableable	getEnableable()
Control.Status	getStatus()
boolean	isEnabled()
void	reset() Resets the control to its default value.
void	setEnabled(boolean newEnabled) Sets whether the control is enabled and and can receive user input.
void	setNotification(Notification newNotification) Sets the component notification.
protected void	setStatus(Control.Status newStatus) Sets the status of the current user input.
protected void	updateStatus() Rechecks user input status of this component, and updates the status.
protected void	updateValid() Rechecks user input validity of this component and all child components, and updates the valid state.

Methods inherited from class com.guiseframework.component.AbstractLayoutComponent

addComponent, applyTheme, applyTheme, getLayout, isLayoutThemeApplied, removeComponent, resetTheme, setLayout, setLayoutThemeApplied, updateTheme

Methods inherited from class com.guiseframework.component.AbstractListCompositeComponent

addComponent, contains, get, getChildComponents, getComponentList, hasChildComponents, indexOf, isEmpty, lastIndexOf, size

Methods inherited from class com.guiseframework.component.AbstractCompositeComponent

addCompositeComponentListener, childComponentValidPropertyChanged, determineChildrenValid, determineValid, dispatchInputEvent, dispatchInputEvent, fireChildComponentAdded, fireChildComponentAdded, fireChildComponentRemoved, fireChildComponentRemoved, initializeChildComponent, loadPreferences, removeCompositeComponentListener, savePreferences, uninitializeChildComponent, validate, validateChildren

Methods inherited from class com.guiseframework.component.AbstractComponent

addCommandListener, addExportStrategy, addImportStrategy, addKeyListener, addMouseListener, addNotificationListener, addPreferenceProperty, depict, equals, exportTransfer, fireInputEvent, fireNotified, fireNotified, getAncestor, getCommandListeners, getComponentByID, getComponentByName, getComponentOrientation, getConstraints, getDepictID, getDepictor, getDescription, getDescriptionContentType, getDirtyComponents, getDirtyComponents, getEventListenerManager, getFlyoverStrategy, getGlyphURI, getInfo, getInfoContentType, getInfoModel, getInputStrategy, getKeyListeners, getLabel, getLabelContentType, getMouseListeners, getName, getNotification, getNotifications, getNotifications, getOrientation, getParent, getPreferenceProperties, getRootComponent, getTheme, hasAncestor, hasCommandListeners, hashCode, hasKeyListeners, hasMouseListeners, importTransfer, initialize, isDragEnabled, isDropEnabled, isFlyoverEnabled, isPreferenceProperty, isThemeApplied, isValid, notify, processEvent, removeCommandListener, removeExportStrategy, removeImportStrategy, removeKeyListener, removeMouseListener, removeNotificationListener, removePreferenceProperty, setConstraints, setDepicted, setDescription, setDescriptionContentType, setDragEnabled, setDropEnabled, setFlyoverEnabled, setFlyoverStrategy, setGlyphURI, setInfo, setInfoContentType, setInputStrategy, setLabel, setLabelContentType, setName, setOrientation, setParent, setThemeApplied, setValid, toString, update

Methods inherited from class com.guiseframework.model.ui.AbstractPresentationModel

BorderLineFarColor, BorderLineFarExtent, BorderLineFarStyle, BorderLineNearColor, BorderLineNearExtent, BorderLineNearStyle, BorderPageFarColor, BorderPageFarExtent, BorderPageFarStyle, BorderPageNearColor, BorderPageNearExtent, BorderPageNearStyle, getBackgroundColor, getBorderColor, getBorderExtent, getBorderStyle, getCornerArcSize, getCornerLineFarPageFarArcSize, getCornerLineFarPageNearArcSize, getCornerLineNearPageFarArcSize, getCornerLineNearPageNearArcSize, getCursor, getExtent, getFontFamilies, getFontSize, getFontStyle, getFontWeight, getLabelFontFamilies, getLabelFontSize, getLabelFontStyle, getLabelFontWeight, getLabelTextColor, getLineExtent, getMarginExtent, getMarginLineFarExtent, getMarginLineNearExtent, getMarginPageFarExtent, getMarginPageNearExtent, getOpacity, getPaddingExtent, getPaddingLineFarExtent, getPaddingLineNearExtent, getPaddingPageFarExtent, getPaddingPageNearExtent, getPageExtent, getStyleID, getTextColor, isDisplayed, isTooltipEnabled, isVisible, setBackgroundColor, setBorderColor, setBorderColor, setBorderExtent, setBorderExtent, setBorderLineFarColor, setBorderLineFarExtent, setBorderLineFarStyle, setBorderLineNearColor, setBorderLineNearExtent, setBorderLineNearStyle, setBorderPageFarColor, setBorderPageFarExtent, setBorderPageFarStyle, setBorderPageNearColor, setBorderPageNearExtent, setBorderPageNearStyle, setBorderStyle, setBorderStyle, setCornerArcSize, setCornerArcSize, setCornerLineFarPageFarArcSize, setCornerLineFarPageNearArcSize, setCornerLineNearPageFarArcSize, setCornerLineNearPageNearArcSize, setCursor, setDisplayed, setExtent, setFontFamilies, setFontSize, setFontStyle, setFontWeight, setLabelFontFamilies, setLabelFontSize, setLabelFontStyle, setLabelFontWeight, setLabelTextColor, setLineExtent, setMarginExtent, setMarginExtent, setMarginLineFarExtent, setMarginLineNearExtent, setMarginPageFarExtent, setMarginPageNearExtent, setOpacity, setPaddingExtent, setPaddingExtent, setPaddingLineFarExtent, setPaddingLineNearExtent, setPaddingPageFarExtent, setPaddingPageNearExtent, setPageExtent, setStyleID, setTextColor, setTooltipEnabled, setVisible

Methods inherited from class com.guiseframework.event.GuiseBoundPropertyObject

getSession

Methods inherited from class com.globalmentor.beans.BoundPropertyObject

addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, createPostponedPropertyChangeEvent, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getForwardPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeSupport, getRepeatPropertyChangeListener, getRepeatVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, getVetoableChangeSupport, hasPropertyChangeListeners, hasVetoableChangeListeners, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.guiseframework.component.LayoutComponent

getLayout, isLayoutThemeApplied, setLayoutThemeApplied

Methods inherited from interface com.guiseframework.component.CompositeComponent

addCompositeComponentListener, getChildComponents, hasChildComponents, removeCompositeComponentListener

Constructor Detail

AbstractLayoutControl

public AbstractLayoutControl(Layout<?> layout)

Layout constructor with a default info model and enableable.

Parameters:

layout - The layout definition for the layout component.

Throws:

java.lang.NullPointerException - if the given layout is null.

AbstractLayoutControl

public AbstractLayoutControl(InfoModel infoModel,
                             Enableable enableable,
                             Layout<?> layout)

Info model, enableable, and layout constructor.

Parameters:

infoModel - The component info model.

enableable - The enableable object in which to store enabled status.

layout - The layout definition for the layout component.

Throws:

java.lang.NullPointerException - if the given info model, enableable, and/or layout is null.

Method Detail

getEnableable

protected Enableable getEnableable()

Returns:

The enableable object decorated by this component.

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:

Control.STATUS_PROPERTY

updateStatus

protected void updateStatus()

Rechecks user input status of this component, and updates the status.

See Also:

setStatus(Control.Status)

determineStatus

protected Control.Status determineStatus()

Checks the user input status of the control. If the component has a notification of Notification.Severity#WARNING, the status is determined to be Status#WARNING. If the component has a notification of Notification.Severity#ERROR, the status is determined to be 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 version also updates the status.

Overrides:

updateValid in class AbstractComponent

See Also:

AbstractComponent.setValid(boolean), updateStatus()

setNotification

public void setNotification(Notification newNotification)

Sets the component notification. This version updates the component status if the notification changes. This is a bound property.

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:

Component.NOTIFICATION_PROPERTY

reset

public void reset()

Resets the control to its default value. This version clears any notification.

Specified by:

reset in interface Control

See Also:

setNotification(Notification)

enabledPropertyChange

protected void enabledPropertyChange(boolean oldValue,
                                     boolean newValue)

Called when the enabled property changes. Child versions should call this version. This version clears any notifications and updates the valid status.

Parameters:

oldValue - The old value of the property.

newValue - The new value of the property.

See Also:

setNotification(Notification), updateValid()

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Enableable

Returns:

Whether the control is enabled and can receive user input.

setEnabled

public void setEnabled(boolean newEnabled)

Sets whether the control is enabled and and can receive user input. This is a bound property of type Boolean.

Specified by:

setEnabled in interface Enableable

Parameters:

newEnabled - true if the control should indicate and accept user input.

See Also:

Enableable.ENABLED_PROPERTY