com.alee.utils.swing.extensions.ContainerMethodsImpl Maven / Gradle / Ivy
The newest version!
/*
* This file is part of WebLookAndFeel library.
*
* WebLookAndFeel library is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* WebLookAndFeel library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with WebLookAndFeel library. If not, see {@link Container} type
* @return {@code true} if the specified {@link Component} belongs to this {@link Container}, {@code false} otherwise
*/
public static boolean contains ( final C container, final Component component )
{
return component != null && component.getParent () == container;
}
/**
* Adds all {@link Component}s from the list into the {@link Container} under the specified index.
*
* @param container {@link Container}
* @param components {@link Component}s to add into this {@link Container}
* @param index index where {@link Component}s should be placed
* @param provided {@link Container} type
* @param actual {@link Container} type
* @return this {@link Container}
*/
public static T add ( final C container, final List components,
final int index )
{
if ( components != null )
{
int skipped = 0;
for ( int i = 0; i < components.size (); i++ )
{
final Component component = components.get ( i );
if ( component != null )
{
container.add ( component, index + i - skipped );
}
else
{
skipped++;
}
}
}
return ( T ) container;
}
/**
* Adds all {@link Component}s from the list into the {@link Container} under the specified constraints.
*
* @param container {@link Container}
* @param components components to add into this {@link Container}
* @param constraints constraints for all {@link Component}s
* @param provided {@link Container} type
* @param actual {@link Container} type
* @return this {@link Container}
*/
public static T add ( final C container, final List components,
final Object constraints )
{
if ( components != null )
{
for ( final Component component : components )
{
if ( component != null )
{
container.add ( component, constraints );
}
}
}
return ( T ) container;
}
/**
* Adds all {@link Component}s from the list into the {@link Container}.
*
* @param container {@link Container}
* @param components {@link Component}s to add into this {@link Container}
* @param provided {@link Container} type
* @param actual {@link Container} type
* @return this {@link Container}
*/
public static T add ( final C container, final List components )
{
if ( components != null )
{
for ( final Component component : components )
{
if ( component != null )
{
container.add ( component );
}
}
}
return ( T ) container;
}
/**
* Adds all specified {@link Component}s into this {@link Container}.
*
* @param container {@link Container}
* @param components {@link Component}s to add into this {@link Container}
* @param provided {@link Container} type
* @param actual {@link Container} type
* @return this {@link Container}
*/
public static T add ( final C container, final Component... components )
{
if ( components != null && components.length > 0 )
{
for ( final Component component : components )
{
if ( component != null )
{
container.add ( component );
}
}
}
return ( T ) container;
}
/**
* Removes all {@link Component}s from the list from this {@link Container}.
*
* @param container {@link Container}
* @param components {@link Component}s to remove from {@link Container}
* @param provided {@link Container} type
* @param actual {@link Container} type
* @return this {@link Container}
*/
public static T remove ( final C container, final List components )
{
if ( components != null )
{
for ( final Component component : components )
{
if ( component != null )
{
container.remove ( component );
}
}
}
return ( T ) container;
}
/**
* Removes all specified {@link Component}s from this {@link Container}.
*
* @param container {@link Container}
* @param components {@link Component}s to remove from {@link Container}
* @param provided {@link Container} type
* @param actual {@link Container} type
* @return this {@link Container}
*/
public static T remove ( final C container, final Component... components )
{
if ( components != null && components.length > 0 )
{
for ( final Component component : components )
{
if ( component != null )
{
container.remove ( component );
}
}
}
return ( T ) container;
}
/**
* Removes all children with the specified {@link Component} {@link Class} type from this {@link Container}.
*
* @param container {@link Container}
* @param componentClass {@link Class} type of child {@link Component}s to be removed
* @param provided {@link Container} type
* @param actual {@link Container} type
* @return this {@link Container}
*/
public static T removeAll ( final C container, final Class componentClass )
{
if ( componentClass != null )
{
for ( int i = 0; i < container.getComponentCount (); i++ )
{
final Component component = container.getComponent ( i );
if ( componentClass.isAssignableFrom ( component.getClass () ) )
{
container.remove ( component );
}
}
}
return ( T ) container;
}
/**
* Returns first {@link Component} contained in this {@link Container}.
*
* @param container {@link Container}
* @param {@link Container} type
* @return first {@link Component} contained in this {@link Container}
*/
public static Component getFirstComponent ( final C container )
{
return container.getComponentCount () > 0 ? container.getComponent ( 0 ) : null;
}
/**
* Returns last {@link Component} contained in this {@link Container}.
*
* @param container {@link Container}
* @param {@link Container} type
* @return last {@link Component} contained in this {@link Container}
*/
public static Component getLastComponent ( final C container )
{
return container.getComponentCount () > 0 ? container.getComponent ( container.getComponentCount () - 1 ) : null;
}
/**
* Makes all {@link Container} child {@link Component} widths equal.
*
* @param container {@link Container}
* @param provided {@link Container} type
* @param actual {@link Container} type
* @return this {@link Container}
*/
public static T equalizeComponentsWidth ( final C container )
{
SwingUtils.equalizeComponentsWidth ( container.getComponents () );
return ( T ) container;
}
/**
* Makes all {@link Container} child {@link Component} heights equal.
*
* @param container {@link Container}
* @param provided {@link Container} type
* @param actual {@link Container} type
* @return this {@link Container}
*/
public static T equalizeComponentsHeight ( final C container )
{
SwingUtils.equalizeComponentsHeight ( container.getComponents () );
return ( T ) container;
}
/**
* Makes all {@link Container} child {@link Component} sizes equal.
*
* @param container {@link Container}
* @param provided {@link Container} type
* @param actual {@link Container} type
* @return this {@link Container}
*/
public static T equalizeComponentsSize ( final C container )
{
SwingUtils.equalizeComponentsSize ( container.getComponents () );
return ( T ) container;
}
/**
* Provides all child {@link Component}s into the specified {@link BiConsumer}.
*
* @param container {@link Container}
* @param consumer child {@link Component}s {@link BiConsumer}
* @param provided {@link Container} type
* @param actual {@link Container} type
* @param child {@link Component}s type
* @return this {@link Container}
*/
public static T forEach ( final C container,
final BiConsumer consumer )
{
final int count = container.getComponentCount ();
for ( int index = 0; index < count; index++ )
{
consumer.accept ( index, ( V ) container.getComponent ( index ) );
}
return ( T ) container;
}
}