com.guiseframework.component
Class AbstractLayoutComponent

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractContainer, AbstractLayoutControl

public abstract class AbstractLayoutComponent
extends AbstractListCompositeComponent
implements LayoutComponent

Abstract implementation of a layout component. Iterating over child components is thread safe.

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.Component

Component.FlyoverStrategy<S extends Component>

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.Component

BOOKMARK_ENABLED_PROPERTY, CONSTRAINTS_PROPERTY, DRAG_ENABLED_PROPERTY, DROP_ENABLED_PROPERTY, FLYOVER_ENABLED_PROPERTY, FLYOVER_STRATEGY_PROPERTY, INPUT_STRATEGY_PROPERTY, NAME_PROPERTY, NOTIFICATION_PROPERTY, ORIENTATION_PROPERTY, THEME_APPLIED_PROPERTY, VALID_PROPERTY

Fields inherited from interface com.guiseframework.model.ui.PresentationModel

BACKGROUND_COLOR_PROPERTY, BORDER_LINE_FAR_COLOR_PROPERTY, BORDER_LINE_FAR_EXTENT_PROPERTY, BORDER_LINE_FAR_STYLE_PROPERTY, BORDER_LINE_NEAR_COLOR_PROPERTY, BORDER_LINE_NEAR_EXTENT_PROPERTY, BORDER_LINE_NEAR_STYLE_PROPERTY, BORDER_PAGE_FAR_COLOR_PROPERTY, BORDER_PAGE_FAR_EXTENT_PROPERTY, BORDER_PAGE_FAR_STYLE_PROPERTY, BORDER_PAGE_NEAR_COLOR_PROPERTY, BORDER_PAGE_NEAR_EXTENT_PROPERTY, BORDER_PAGE_NEAR_STYLE_PROPERTY, CORNER_LINE_FAR_PAGE_FAR_ARC_SIZE_PROPERTY, CORNER_LINE_FAR_PAGE_NEAR_ARC_SIZE_PROPERTY, CORNER_LINE_NEAR_PAGE_FAR_ARC_SIZE_PROPERTY, CORNER_LINE_NEAR_PAGE_NEAR_ARC_SIZE_PROPERTY, CURSOR_PROPERTY, FONT_FAMILIES_PROPERTY, FONT_SIZE_PROPERTY, FONT_STYLE_PROPERTY, FONT_WEIGHT_BOLD, FONT_WEIGHT_NORMAL, FONT_WEIGHT_PROPERTY, LABEL_FONT_FAMILIES_PROPERTY, LABEL_FONT_SIZE_PROPERTY, LABEL_FONT_STYLE_PROPERTY, LABEL_FONT_WEIGHT_PROPERTY, LABEL_TEXT_COLOR_PROPERTY, LINE_EXTENT_PROPERTY, MARGIN_LINE_FAR_EXTENT_PROPERTY, MARGIN_LINE_NEAR_EXTENT_PROPERTY, MARGIN_PAGE_FAR_EXTENT_PROPERTY, MARGIN_PAGE_NEAR_EXTENT_PROPERTY, OPACITY_PROPERTY, PADDING_LINE_FAR_EXTENT_PROPERTY, PADDING_LINE_NEAR_EXTENT_PROPERTY, PADDING_PAGE_FAR_EXTENT_PROPERTY, PADDING_PAGE_NEAR_EXTENT_PROPERTY, PAGE_EXTENT_PROPERTY, ROUNDED_CORNER_ARC_SIZE, STYLE_ID_PROPERTY, TEXT_COLOR_PROPERTY, TOOLTIP_ENABLED_PROPERTY, VISIBLE_PROPERTY

Fields inherited from interface com.guiseframework.model.Displayable

DISPLAYED_PROPERTY

Fields inherited from interface com.guiseframework.model.InfoModel

DESCRIPTION_CONTENT_TYPE_PROPERTY, DESCRIPTION_PROPERTY, INFO_CONTENT_TYPE_PROPERTY, INFO_PROPERTY

Fields inherited from interface com.guiseframework.model.LabelModel

GLYPH_URI_PROPERTY, LABEL_CONTENT_TYPE_PROPERTY, LABEL_PROPERTY

Fields inherited from interface com.guiseframework.model.Model

PLAIN_TEXT_CONTENT_TYPE, XHTML_CONTENT_TYPE, XHTML_FRAGMENT_CONTENT_TYPE

Constructor Summary

AbstractLayoutComponent(InfoModel infoModel, Layout<? extends Constraints> layout)
Info model and layout constructor.

AbstractLayoutComponent(Layout<? extends Constraints> layout)
Layout constructor with a default info model.

Method Summary

protected void	addComponent(int index, Component childComponent) Adds a child component at the specified index.
void	applyTheme() Applies the theme to this object.
void	applyTheme(Theme theme) Applies a theme and its parents to this object.
Layout<? extends Constraints>	getLayout()
boolean	isLayoutThemeApplied()
protected void	removeComponent(Component childComponent) Removes a component from the layout component.
void	resetTheme() Resets this object's theme.
protected <T extends Constraints> void	setLayout(Layout<T> newLayout) Sets the layout definition for the component.
void	setLayoutThemeApplied(boolean newLayoutThemeApplied) Sets whether a theme has been applied to this component's layout.
void	updateTheme() Updates this object's theme.

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, setNotification, setOrientation, setParent, setThemeApplied, setValid, toString, update, updateValid

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.CompositeComponent

addCompositeComponentListener, getChildComponents, hasChildComponents, removeCompositeComponentListener

Methods inherited from interface com.guiseframework.component.Component

addCommandListener, addExportStrategy, addImportStrategy, addKeyListener, addMouseListener, addNotificationListener, addPreferenceProperty, dispatchInputEvent, exportTransfer, fireInputEvent, getAncestor, getComponentOrientation, getConstraints, getDepictor, getFlyoverStrategy, getInputStrategy, getName, getNotification, getOrientation, getParent, getPreferenceProperties, getTheme, hasCommandListeners, hasKeyListeners, hasMouseListeners, importTransfer, initialize, isDragEnabled, isDropEnabled, isFlyoverEnabled, isPreferenceProperty, isThemeApplied, isValid, loadPreferences, notify, removeCommandListener, removeExportStrategy, removeImportStrategy, removeKeyListener, removeMouseListener, removeNotificationListener, removePreferenceProperty, savePreferences, setConstraints, setDragEnabled, setDropEnabled, setFlyoverEnabled, setFlyoverStrategy, setInputStrategy, setName, setNotification, setOrientation, setParent, setThemeApplied, validate

Methods inherited from interface com.guiseframework.platform.DepictedObject

depict, getDepictID, getSession, processEvent

Methods inherited from interface com.guiseframework.model.ui.PresentationModel

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, getSession, 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 interface com.guiseframework.model.InfoModel

getDescription, getDescriptionContentType, getInfo, getInfoContentType, setDescription, setDescriptionContentType, setInfo, setInfoContentType

Methods inherited from interface com.guiseframework.model.LabelModel

getGlyphURI, getLabel, getLabelContentType, setGlyphURI, setLabel, setLabelContentType

Methods inherited from interface com.globalmentor.beans.PropertyBindable

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, hasPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface com.globalmentor.beans.PropertyConstrainable

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, hasVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener

Constructor Detail

AbstractLayoutComponent

public AbstractLayoutComponent(Layout<? extends Constraints> layout)

Layout constructor with a default info model.

Parameters:

layout - The layout definition for the container.

Throws:

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

AbstractLayoutComponent

public AbstractLayoutComponent(InfoModel infoModel,
                               Layout<? extends Constraints> layout)

Info model and layout constructor.

Parameters:

infoModel - The component info model.

layout - The layout definition for the container.

Throws:

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

Method Detail

addComponent

protected void addComponent(int index,
                            Component childComponent)

Adds a child component at the specified index. Any class that overrides this method must call this version.

Overrides:

addComponent in class AbstractListCompositeComponent

Parameters:

index - The index at which the component should be added.

childComponent - The component to add to this component.

Throws:

java.lang.IllegalArgumentException - if the component already has a parent or if the component is already a child of this composite component.

java.lang.IllegalStateException - if the installed layout does not support default constraints.

java.lang.IndexOutOfBoundsException - if the index is less than zero or greater than the number of child components.

removeComponent

protected void removeComponent(Component childComponent)

Removes a component from the layout component.

Overrides:

removeComponent in class AbstractListCompositeComponent

Parameters:

childComponent - The component to remove.

Throws:

java.lang.IllegalArgumentException - if the component does not recognize this composite component as its parent or the component is not a member of this composite component.

getLayout

public Layout<? extends Constraints> getLayout()

Specified by:

getLayout in interface LayoutComponent

Returns:

The layout definition for the component.

setLayout

protected <T extends Constraints> void setLayout(Layout<T> newLayout)

Sets the layout definition for the component. This is a bound property. The layout is marked as not yet having a theme applied, as the specific theme rules applied to the layout may depend on the layout's owner.

Parameters:

newLayout - The new layout definition for the container.

Throws:

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

See Also:

LayoutComponent.LAYOUT_PROPERTY, #setPropertiesInitialized(boolean)

isLayoutThemeApplied

public boolean isLayoutThemeApplied()

Specified by:

isLayoutThemeApplied in interface LayoutComponent

Returns:

Whether a theme has been applied to this component's layout.

setLayoutThemeApplied

public void setLayoutThemeApplied(boolean newLayoutThemeApplied)

Sets whether a theme has been applied to this component's layout. This is a bound property of type Boolean.

Specified by:

setLayoutThemeApplied in interface LayoutComponent

Parameters:

newLayoutThemeApplied - true if a theme has been applied to this component's layout, else false.

See Also:

LayoutComponent.LAYOUT_THEME_APPLIED_PROPERTY, AbstractComponent.setThemeApplied(boolean)

resetTheme

public void resetTheme()

Resets this object's theme. This method sets to false the state of whether a theme has been applied to this object. This method is called for any child components resetting its own theme. No new theme is actually loaded. There is normally no need to override this method or to call this method directly by applications. This version resets the theme of the given layout.

Specified by:

resetTheme in interface Component

Overrides:

resetTheme in class AbstractCompositeComponent

See Also:

AbstractComponent.setThemeApplied(boolean), setLayoutThemeApplied(boolean)

updateTheme

public void updateTheme()
                 throws java.io.IOException

Updates this object's theme. This method checks whether a theme has been applied to this object. If a theme has not been applied to this object this method calls applyTheme(). This method is called for any child components before applying the theme to the component itself, to assure that child theme updates have already occured before theme updates occur for this component. There is normally no need to override this method or to call this method directly by applications. This version checks to see if the theme needs to be applied to the given layout.

Specified by:

updateTheme in interface Component

Overrides:

updateTheme in class AbstractCompositeComponent

Throws:

java.io.IOException - if there was an error loading or applying a theme.

See Also:

AbstractComponent.isThemeApplied(), isLayoutThemeApplied(), applyTheme()

applyTheme

public void applyTheme()
                throws java.io.IOException

Applies the theme to this object. Themes are only applied of the application is themed. This method may be overridden to effectively override theme settings by ensuring the state of important properties after the theme has been set. If the theme is successfully applied, this method updates the theme applied status. This version applies the theme to the current layout and updates the layout theme applied status.

Specified by:

applyTheme in interface Component

Overrides:

applyTheme in class AbstractComponent

Throws:

java.io.IOException - if there was an error loading or applying a theme.

See Also:

GuiseApplication.isThemed(), AbstractComponent.getTheme(), applyTheme(Theme), AbstractComponent.setThemeApplied(boolean), setLayoutThemeApplied(boolean)

applyTheme

public void applyTheme(Theme theme)

Applies a theme and its parents to this object. The theme's rules will be applied to this object and any related objects. Theme application occurs unconditionally, regardless of whether themes have been applied to this component before. There is normally no need to call this method directly by applications. This version applies the theme to the current layout.

Specified by:

applyTheme in interface Component

Overrides:

applyTheme in class AbstractComponent

Parameters:

theme - The theme to apply to the object.