diff options
Diffstat (limited to 'src/com/itmill/toolkit/ui/ComponentContainer.java')
| -rw-r--r-- | src/com/itmill/toolkit/ui/ComponentContainer.java | 333 |
1 files changed, 184 insertions, 149 deletions
diff --git a/src/com/itmill/toolkit/ui/ComponentContainer.java b/src/com/itmill/toolkit/ui/ComponentContainer.java index 40be0a559f..5010becf10 100644 --- a/src/com/itmill/toolkit/ui/ComponentContainer.java +++ b/src/com/itmill/toolkit/ui/ComponentContainer.java @@ -1,218 +1,253 @@ /* ************************************************************************* - IT Mill Toolkit + IT Mill Toolkit - Development of Browser User Interfaces Made Easy + Development of Browser User Interfaces Made Easy - Copyright (C) 2000-2006 IT Mill Ltd - - ************************************************************************* + Copyright (C) 2000-2006 IT Mill Ltd + + ************************************************************************* - This product is distributed under commercial license that can be found - from the product package on license.pdf. Use of this product might - require purchasing a commercial license from IT Mill Ltd. For guidelines - on usage, see licensing-guidelines.html + This product is distributed under commercial license that can be found + from the product package on license.pdf. Use of this product might + require purchasing a commercial license from IT Mill Ltd. For guidelines + on usage, see licensing-guidelines.html - ************************************************************************* - - For more information, contact: - - IT Mill Ltd phone: +358 2 4802 7180 - Ruukinkatu 2-4 fax: +358 2 4802 7181 - 20540, Turku email: info@itmill.com - Finland company www: www.itmill.com - - Primary source for information and releases: www.itmill.com + ************************************************************************* + + For more information, contact: + + IT Mill Ltd phone: +358 2 4802 7180 + Ruukinkatu 2-4 fax: +358 2 4802 7181 + 20540, Turku email: info@itmill.com + Finland company www: www.itmill.com + + Primary source for information and releases: www.itmill.com - ********************************************************************** */ + ********************************************************************** */ package com.itmill.toolkit.ui; import java.util.Iterator; -/** - * Extension to the {@link Component} interface which adds to it the capacity - * to contain other components. All UI elements that can have child elements +/** + * Extension to the {@link Component} interface which adds to it the capacity to + * contain other components. All UI elements that can have child elements * implement this interface. * * @author IT Mill Ltd. - * @version @VERSION@ + * @version + * @VERSION@ * @since 3.0 */ public interface ComponentContainer extends Component { - /** - * Adds the component into this container. - * - * @param c the component to be added. - */ - public void addComponent(Component c); - - /** - * Removes the component from this container. - * - * @param c the component to be added. - */ - public void removeComponent(Component c); - - /** - * Removes all components from this container. - */ - public void removeAllComponents(); - - /** - * Replaces the component in the container with another one without changing position. + /** + * Adds the component into this container. * - * <p>This method replaces component with another one is such way that the new component - * overtakes the position of the old component. If the old component is not in the - * container, the new component is added to the container. If the both component are - * already in the container, their positions are swapped. - * Component attach and detach events should be taken care as with add and remove.</p> + * @param c + * the component to be added. + */ + public void addComponent(Component c); + + /** + * Removes the component from this container. * - * @param oldComponent the old component that will be replaced. - * @param newComponent the new component to be replaced. + * @param c + * the component to be added. + */ + public void removeComponent(Component c); + + /** + * Removes all components from this container. + */ + public void removeAllComponents(); + + /** + * Replaces the component in the container with another one without changing + * position. + * + * <p> + * This method replaces component with another one is such way that the new + * component overtakes the position of the old component. If the old + * component is not in the container, the new component is added to the + * container. If the both component are already in the container, their + * positions are swapped. Component attach and detach events should be taken + * care as with add and remove. + * </p> + * + * @param oldComponent + * the old component that will be replaced. + * @param newComponent + * the new component to be replaced. */ public void replaceComponent(Component oldComponent, Component newComponent); - /** - * Gets an iterator to the collection of contained components. Using - * this iterator it is possible to step through all components contained - * in this container. - * - * @return the component iterator. - */ - public Iterator getComponentIterator(); - - /** - * Moves all components from an another container into this container. - * The components are removed from <code>source</code>. - * - * @param source the container which contains the components that are to - * be moved to this container. - */ - public void moveComponentsFrom(ComponentContainer source); - - /** - * Listens the component attach events. - * @param listener the listener to add. - */ - public void addListener(ComponentAttachListener listener); - - /** - * Stops the listening component attach events. - * @param listener the listener to removed. - */ - public void removeListener(ComponentAttachListener listener); - - /** - * Listens the component detach events. - */ - public void addListener(ComponentDetachListener listener); - - /** - * Stops the listening component detach events. - */ - public void removeListener(ComponentDetachListener listener); - - /** - * Component attach listener interface. + /** + * Gets an iterator to the collection of contained components. Using this + * iterator it is possible to step through all components contained in this + * container. + * + * @return the component iterator. + */ + public Iterator getComponentIterator(); + + /** + * Moves all components from an another container into this container. The + * components are removed from <code>source</code>. + * + * @param source + * the container which contains the components that are to be + * moved to this container. + */ + public void moveComponentsFrom(ComponentContainer source); + + /** + * Listens the component attach events. + * + * @param listener + * the listener to add. + */ + public void addListener(ComponentAttachListener listener); + + /** + * Stops the listening component attach events. + * + * @param listener + * the listener to removed. + */ + public void removeListener(ComponentAttachListener listener); + + /** + * Listens the component detach events. + */ + public void addListener(ComponentDetachListener listener); + + /** + * Stops the listening component detach events. + */ + public void removeListener(ComponentDetachListener listener); + + /** + * Component attach listener interface. */ public interface ComponentAttachListener { /** * A new component is attached to container. - * @param event the component attach event. - */ + * + * @param event + * the component attach event. + */ public void componentAttachedToContainer(ComponentAttachEvent event); - } + } - /** - * Component detach listener interface. + /** + * Component detach listener interface. */ public interface ComponentDetachListener { - /** + /** * A component has been detached from container. - * @param event the component detach event. - */ + * + * @param event + * the component detach event. + */ public void componentDetachedFromContainer(ComponentDetachEvent event); - } + } - /** - * Component attach event sent when a component is attached to container. + /** + * Component attach event sent when a component is attached to container. */ - public class ComponentAttachEvent extends Component.Event { - + public class ComponentAttachEvent extends Component.Event { + /** - * Serial generated by eclipse. - */ - private static final long serialVersionUID = 3257285812184692019L; - - private Component component; + * Serial generated by eclipse. + */ + private static final long serialVersionUID = 3257285812184692019L; + + private Component component; - /** + /** * Creates a new attach event. - * @param container the component container the component has been detached to. - * @param attachedComponent the component that has been attached. + * + * @param container + * the component container the component has been detached + * to. + * @param attachedComponent + * the component that has been attached. */ - public ComponentAttachEvent(ComponentContainer container, Component attachedComponent) { + public ComponentAttachEvent(ComponentContainer container, + Component attachedComponent) { super(container); - this.component = attachedComponent; - } - - /** + this.component = attachedComponent; + } + + /** * Gets the component container. - * @param the component container. + * + * @param the + * component container. */ public ComponentContainer getContainer() { - return (ComponentContainer) getSource(); + return (ComponentContainer) getSource(); } - - /** + + /** * Gets the attached component. - * @param the attach component. + * + * @param the + * attach component. */ public Component getAttachedComponent() { - return component; + return component; } } - /** - * Component detach event sent when a component is detached from container. + /** + * Component detach event sent when a component is detached from container. */ - public class ComponentDetachEvent extends Component.Event { - + public class ComponentDetachEvent extends Component.Event { + /** - * Serial generated by eclipse. - */ - private static final long serialVersionUID = 3618140052337930290L; - - private Component component; + * Serial generated by eclipse. + */ + private static final long serialVersionUID = 3618140052337930290L; + + private Component component; - /** + /** * Creates a new detach event. - * @param container the component container the component has been detached from. - * @param detachedComponent the component that has been detached. + * + * @param container + * the component container the component has been detached + * from. + * @param detachedComponent + * the component that has been detached. */ - public ComponentDetachEvent(ComponentContainer container, Component detachedComponent) { + public ComponentDetachEvent(ComponentContainer container, + Component detachedComponent) { super(container); - this.component = detachedComponent; - } - - /** + this.component = detachedComponent; + } + + /** * Gets the component container. - * @param the component container. + * + * @param the + * component container. */ public ComponentContainer getContainer() { - return (ComponentContainer) getSource(); + return (ComponentContainer) getSource(); } - - /** + + /** * Gets the detached component. - * @return the detached component. + * + * @return the detached component. */ public Component getDetachedComponent() { - return component; + return component; } } |