com.guiseframework.component
Interface ApplicationFrame

All Superinterfaces:
Component, CompositeComponent, ContentComponent, DepictedObject, Displayable, Frame, InfoModel, InputFocusableComponent, InputFocusGroupComponent, LabelModel, ModalComponent<Frame.Mode>, Model, PresentationModel, com.globalmentor.beans.PropertyBindable, com.globalmentor.beans.PropertyConstrainable
All Known Implementing Classes:
AbstractApplicationFrame, DefaultApplicationFrame

public interface ApplicationFrame
extends Frame

The root frame of an application.

Author:
Garret Wilson

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.guiseframework.component.Frame
Frame.Mode, Frame.State
 
Field Summary
 
Fields inherited from interface com.guiseframework.component.Frame
CLOSE_ACTION_CONTROL_PROPERTY, MENU_PROPERTY, MODAL_PROPERTY, MOVABLE_PROPERTY, OPEN_EFFECT_PROPERTY, RELATED_COMPONENT_PROPERTY, RESIZABLE_PROPERTY, STATE_PROPERTY, TITLE_BACKGROUND_COLOR_PROPERTY, TITLE_VISIBLE_PROPERTY, TOOLBAR_PROPERTY
 
Fields inherited from interface com.guiseframework.component.ContentComponent
CONTENT_PROPERTY
 
Fields inherited from interface com.guiseframework.component.ModalComponent
MODE_PROPERTY
 
Fields inherited from interface com.guiseframework.component.InputFocusGroupComponent
INPUT_FOCUS_STRATEGY_PROPERTY, INPUT_FOCUSED_COMPONENT_PROPERTY
 
Method Summary
 void addChildFrame(Frame frame)
          Adds a frame to the list of child frames.
 java.lang.Iterable<Frame> getChildFrames()
           
 void removeChildFrame(Frame frame)
          Removes a frame from the list of child frames.
 
Methods inherited from interface com.guiseframework.component.Frame
canClose, close, getCloseActionControl, getCloseActionPrototype, getMenu, getOpenEffect, getRelatedComponent, getState, getTitleBackgroundColor, getToolbar, isModal, isMovable, isResizable, isTitleVisible, open, open, open, setCloseActionControl, setMenu, setModal, setMovable, setOpenEffect, setRelatedComponent, setResizable, setTitleBackgroundColor, setTitleVisible, setToolbar
 
Methods inherited from interface com.guiseframework.component.ContentComponent
getContent, setContent
 
Methods inherited from interface com.guiseframework.component.CompositeComponent
addCompositeComponentListener, getChildComponents, hasChildComponents, removeCompositeComponentListener
 
Methods inherited from interface com.guiseframework.component.ModalComponent
getMode, setMode
 
Methods inherited from interface com.guiseframework.component.InputFocusGroupComponent
getInputFocusedComponent, getInputFocusStrategy, setInputFocusedComponent, setInputFocusStrategy
 

Method Detail

getChildFrames

java.lang.Iterable<Frame> getChildFrames()
Returns:
An iterable to all child frames.

addChildFrame

void addChildFrame(Frame frame)
Adds a frame to the list of child frames. This method should usually only be called by the frames themselves.

Parameters:
frame - The frame to add.
Throws:
java.lang.NullPointerException - if the given frame is null.
java.lang.IllegalArgumentException - if the given frame is this frame.

removeChildFrame

void removeChildFrame(Frame frame)
Removes a frame from the list of child frames. This method should usually only be called by the frames themselves.

Parameters:
frame - The frame to remove.
Throws:
java.lang.NullPointerException - if the given frame is null.
java.lang.IllegalArgumentException - if the given frame is this frame.


Copyright © 2005-2010 GlobalMentor, Inc. All Rights Reserved.