com.guiseframework.component
Class ScrollControl

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.AbstractArrayCompositeComponent
                              com.guiseframework.component.AbstractEnumCompositeComponent<ScrollControl.ScrollComponent>
                                  com.guiseframework.component.ScrollControl

All Implemented Interfaces:

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

public class ScrollControl
extends AbstractEnumCompositeComponent<ScrollControl.ScrollComponent>
implements ContentComponent, Control

A control that allows the user to scroll its contents The control's contents are specified using setContent(Component).

Author:

Garret Wilson

Nested Class Summary

protected static class

ScrollControl.ScrollComponent The enumeration of frame components.

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

CONTENT_PROPERTY

Fields inherited from interface com.guiseframework.component.Control

STATUS_PROPERTY

Fields inherited from interface com.guiseframework.model.Enableable

ENABLED_PROPERTY

Constructor Summary

ScrollControl()
Default constructor with no content component.

ScrollControl(Component component)
Component constructor.

Method Summary

Component	getContent()
protected Enableable	getEnableable()
Control.Status	getStatus()
boolean	isEnabled()
void	reset() Resets the control to its default value.
void	setContent(Component newContent) Sets the content child component.
void	setEnabled(boolean newEnabled) Sets whether the control is enabled and and can receive user input.
protected void	setStatus(Control.Status newStatus) Sets the status of the current user input.

Methods inherited from class com.guiseframework.component.AbstractEnumCompositeComponent

getComponent, setComponent

Methods inherited from class com.guiseframework.component.AbstractArrayCompositeComponent

getChildComponents, getChildList, getComponent, hasChildComponents, setComponent

Methods inherited from class com.guiseframework.component.AbstractMultipleCompositeComponent

addComponent, removeComponent

Methods inherited from class com.guiseframework.component.AbstractCompositeComponent

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

Methods inherited from class com.guiseframework.component.AbstractComponent

addCommandListener, addExportStrategy, addImportStrategy, addKeyListener, addMouseListener, addNotificationListener, addPreferenceProperty, applyTheme, applyTheme, 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

Constructor Detail

ScrollControl

public ScrollControl()

Default constructor with no content component.

Parameters:

component - The single content child component, or null if this control should have no content child component.

ScrollControl

public ScrollControl(Component component)

Component constructor.

Parameters:

component - The single child component, or null if this control should have no child component.

Method Detail

getEnableable

protected Enableable getEnableable()

Returns:

The enableable object decorated by this component.

getContent

public Component getContent()

Specified by:

getContent in interface ContentComponent

Returns:

The content child component, or null if this frame does not have a content child component.

See Also:

ScrollControl.ScrollComponent.CONTENT_COMPONENT

setContent

public void setContent(Component newContent)

Sets the content child component. This is a bound property.

Specified by:

setContent in interface ContentComponent

Parameters:

newContent - The content child component, or null if this frame does not have a content child component.

See Also:

ScrollControl.ScrollComponent.CONTENT_COMPONENT, ContentComponent.CONTENT_PROPERTY

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

reset

public void reset()

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

Specified by:

reset in interface Control

See Also:

AbstractComponent.setNotification(Notification)

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