plugins.adufour.ezplug
Class EzGroup

java.lang.Object
  plugins.adufour.ezplug.EzComponent
      plugins.adufour.ezplug.EzGroup

All Implemented Interfaces:

java.lang.Iterable<EzComponent>

public class EzGroup
extends EzComponent
implements java.lang.Iterable<EzComponent>

Class defining a group of EzComponents, which will appear in the interface within a titled box.

Author:

Alexandre Dufour

Nested Class Summary

static interface

EzGroup.FoldListener

Field Summary

java.util.List<EzComponent>

components

Fields inherited from class plugins.adufour.ezplug.EzComponent

name, visible

Constructor Summary

EzGroup(java.lang.String groupTitle, EzComponent... ezComponents)
Creates a new EzGroup with the given box title and set of ezComponents.

Method Summary

void	addEzComponent(EzComponent... ezComponents) Adds the specified EzComponents to this group
void	addFoldListener(EzGroup.FoldListener listener)
void	addTo(java.awt.Container container)
void	dispose()
java.util.Iterator<EzComponent>	iterator()
void	setToolTipText(java.lang.String text) Assigns a tool-tip text to the variable, which pops up when the user hovers the mouse on it.

Methods inherited from class plugins.adufour.ezplug.EzComponent

getGroup, getVisible, isVisible, setGroup, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

components

public final java.util.List<EzComponent> components

Constructor Detail

EzGroup

public EzGroup(java.lang.String groupTitle,
               EzComponent... ezComponents)

Creates a new EzGroup with the given box title and set of ezComponents. Each component will be drawn on the interface in their order of declaration.

Parameters:

groupTitle - The group title (will appear on the enclosing box in the user interface)

ezComponents - the components to add (must be non-empty)

Throws:

java.lang.IllegalArgumentException - if ezComponents is empty

Method Detail

addFoldListener

public void addFoldListener(EzGroup.FoldListener listener)

addEzComponent

public void addEzComponent(EzComponent... ezComponents)

Adds the specified EzComponents to this group

Parameters:

ezComponents - the components to add

addTo

public void addTo(java.awt.Container container)

Specified by:

addTo in class EzComponent

setToolTipText

public void setToolTipText(java.lang.String text)

Description copied from class: EzComponent

Assigns a tool-tip text to the variable, which pops up when the user hovers the mouse on it.

Specified by:

setToolTipText in class EzComponent

Parameters:

text - the text to display (usually no more than 20 words)

dispose

public void dispose()

Overrides:

dispose in class EzComponent

iterator

public java.util.Iterator<EzComponent> iterator()

Specified by:

iterator in interface java.lang.Iterable<EzComponent>