Package io.guise.framework.component
Interface CompositeComponent
-
- All Superinterfaces:
Component
,DepictedObject
,Displayable
,InfoModel
,LabelModel
,Model
,PresentationModel
,com.globalmentor.beans.PropertyBindable
,com.globalmentor.beans.PropertyConstrainable
- All Known Subinterfaces:
ApplicationFrame
,ArrangeContainer
,CardContainer
,CardControl
,Container
,ContainerControl
,ContentComponent
,DialogFrame<V>
,FlyoverFrame
,Frame
,LayoutComponent
,LayoutControl
,Menu
,ModalFrame<R>
,ModalNavigationPanel<R>
,OptionDialogFrame<O>
,Panel
- All Known Implementing Classes:
AboutPanel
,AbstractApplicationFrame
,AbstractArrayCompositeComponent
,AbstractBox
,AbstractCardPanel
,AbstractCompositeComponent
,AbstractCompositeStateComponent
,AbstractCompositeStateControl
,AbstractContainer
,AbstractContainerControl
,AbstractContainerValueControl
,AbstractDialogFrame
,AbstractEditComponentTextControl
,AbstractEditValuePanel
,AbstractEnumCompositeComponent
,AbstractFlyoverFrame
,AbstractFrame
,AbstractLayoutComponent
,AbstractLayoutControl
,AbstractLayoutValueControl
,AbstractListCompositeComponent
,AbstractListSelectContainerControl
,AbstractListSelectControl
,AbstractMenu
,AbstractModalFrame
,AbstractModalNavigationPanel
,AbstractMultipleCompositeComponent
,AbstractOptionDialogFrame
,AbstractPanel
,AbstractSequenceTaskPanel
,AbstractSingleCompositeComponent
,AbstractValuedPanel
,AccordionMenu
,ArrangePanel
,AutoNavigationPathBreadcrumbLinkPanel
,BooleanValueControlSelectControl
,BusyPanel
,CalendarControl
,CalendarDialogFrame
,CardPanel
,CardTabControl
,DateTimeControl
,DateTimeFieldsControl
,DefaultApplicationFrame
,DefaultDialogFrame
,DefaultFlyoverFrame
,DefaultFrame
,DefaultModalFrame
,DefaultModalNavigationPanel
,DropMenu
,EditComponentLabelControl
,EditComponentTextControl
,GroupPanel
,LayoutPanel
,ListControl
,MessageOptionDialogFrame
,NamePanel
,NavigationPathBreadcrumbLinkPanel
,NotificationOptionDialogFrame
,PasswordAuthenticationPanel
,PlatformFileUploadPanel
,ScrollControl
,SectionPanel
,SequenceCardPanel
,SpinnerControl
,TabbedPanel
,TabContainerControl
,TabControl
,Table
,TextBox
,Toolbar
,TreeControl
public interface CompositeComponent extends Component
A component that can contain other components. A composite component may contain other components, but only aContainer
allows for application addition and removal of child components.- Author:
- Garret Wilson
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface io.guise.framework.component.Component
Component.FlyoverStrategy<S extends Component>
-
-
Field Summary
-
Fields inherited from interface io.guise.framework.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 io.guise.framework.model.Displayable
DISPLAYED_PROPERTY
-
Fields inherited from interface io.guise.framework.model.InfoModel
DESCRIPTION_CONTENT_TYPE_PROPERTY, DESCRIPTION_PROPERTY, INFO_CONTENT_TYPE_PROPERTY, INFO_PROPERTY
-
Fields inherited from interface io.guise.framework.model.LabelModel
GLYPH_URI_PROPERTY, LABEL_CONTENT_TYPE_PROPERTY, LABEL_PROPERTY
-
Fields inherited from interface io.guise.framework.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
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addCompositeComponentListener(CompositeComponentListener compositeComponentListener)
Adds a composite component listener.java.lang.Iterable<Component>
getChildComponents()
boolean
hasChildComponents()
void
removeCompositeComponentListener(CompositeComponentListener compositeComponentListener)
Removes a composite component listener.-
Methods inherited from interface io.guise.framework.component.Component
addCommandListener, addExportStrategy, addImportStrategy, addKeyListener, addMouseListener, addNotificationListener, addPreferenceProperty, applyTheme, applyTheme, 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, resetTheme, savePreferences, setConstraints, setDragEnabled, setDropEnabled, setFlyoverEnabled, setFlyoverStrategy, setInputStrategy, setName, setNotification, setOrientation, setParent, setThemeApplied, updateTheme, validate
-
Methods inherited from interface io.guise.framework.platform.DepictedObject
depict, getDepictID, getSession, processEvent
-
Methods inherited from interface io.guise.framework.model.InfoModel
getDescription, getDescriptionContentType, getInfo, getInfoContentType, setDescription, setDescriptionContentType, setInfo, setInfoContentType
-
Methods inherited from interface io.guise.framework.model.LabelModel
getGlyphURI, getLabel, getLabelContentType, setGlyphURI, setLabel, setLabelContentType
-
Methods inherited from interface io.guise.framework.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
-
-
-
-
Method Detail
-
hasChildComponents
boolean hasChildComponents()
- Returns:
- Whether this component has childh components.
-
getChildComponents
java.lang.Iterable<Component> getChildComponents()
- Returns:
- An iterable to child components.
-
addCompositeComponentListener
void addCompositeComponentListener(CompositeComponentListener compositeComponentListener)
Adds a composite component listener. An event will be fired for each descendant component added or removed, with the event target indicating the parent composite component of the change.- Parameters:
compositeComponentListener
- The composite component listener to add.
-
removeCompositeComponentListener
void removeCompositeComponentListener(CompositeComponentListener compositeComponentListener)
Removes a composite component listener. An event will be fired for each descendant component added or removed, with the event target indicating the parent composite component of the change.- Parameters:
compositeComponentListener
- The composite component listener to remove.
-
-