Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* 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 .
*/
package com.alee.laf.grouping;
import com.alee.extended.layout.AbstractLayoutManager;
import com.alee.painter.decoration.DecorationUtils;
import com.alee.utils.SwingUtils;
import com.alee.utils.TextUtils;
import com.alee.utils.general.Pair;
import com.alee.utils.swing.UnselectableButtonGroup;
import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
import javax.swing.*;
import java.awt.*;
import java.util.Map;
import java.util.WeakHashMap;
/**
* @author Mikle Garin
*/
public abstract class AbstractGroupingLayout extends AbstractLayoutManager implements GroupingLayout
{
/**
* Whether or not should visually group provided children components.
* It is always enabled by default but can be disabled if required.
* Disabling this option will automatically ungroup all components.
*/
@XStreamAsAttribute
protected Boolean group;
/**
* Whether or not should group toggle state elements like togglebuttons, radiobuttons or checkboxes.
* Only elements placed straight within this {@link com.alee.laf.grouping.GroupPane} are grouped.
*/
@XStreamAsAttribute
protected Boolean groupButtons;
/**
* Displayed children decoration sides.
* It might be useful to disable sides decoration while keeping it between the child components.
*/
@XStreamAsAttribute
protected String sides;
/**
* Container children components.
*/
protected transient Map> children;
/**
* Button group used to group toggle state elements placed within container.
*/
protected transient UnselectableButtonGroup buttonGroup;
@Override
public boolean isGrouping ()
{
return group == null || group;
}
/**
* Sets whether or not components should be visually grouped.
*
* @param group whether or not components should be visually grouped
*/
public void setGroup ( final boolean group )
{
if ( isGrouping () != group )
{
this.group = group;
resetDescriptors ();
}
}
/**
* Returns whether or not should group toggle state elements.
*
* @return true if should group toggle state elements, false otherwise
*/
public boolean isGroupButtons ()
{
return groupButtons == null || groupButtons;
}
/**
* Sets whether or not should group toggle state elements.
* Changing this flag will automatically group or ungroup toggle state elements in this pane.
*
* @param group whether or not should group toggle state elements
*/
public void setGroupButtons ( final boolean group )
{
if ( isGroupButtons () != group )
{
this.groupButtons = group;
updateButtonGrouping ();
}
}
/**
* Returns newly created button group.
*
* @return newly created button group
*/
protected UnselectableButtonGroup createButtonGroup ()
{
return new UnselectableButtonGroup ( false );
}
/**
* Ungroups all buttons.
*/
protected void clearGrouping ()
{
if ( buttonGroup != null )
{
buttonGroup.removeAll ();
buttonGroup = null;
}
}
/**
* Updates button grouping.
*/
protected void updateButtonGrouping ()
{
// Clearing grouping first
clearGrouping ();
// Grouping buttons
if ( isGroupButtons () )
{
buttonGroup = createButtonGroup ();
if ( children != null )
{
for ( final Map.Entry> entry : children.entrySet () )
{
final Component component = entry.getKey ();
if ( isGroupable ( component ) )
{
buttonGroup.add ( ( AbstractButton ) component );
}
}
}
}
}
/**
* Returns whether or not specified component is a groupable button.
*
* @param component component to process
* @return true if specified component is a groupable button, false otherwise
*/
protected boolean isGroupable ( final Component component )
{
return component != null && ( component instanceof JToggleButton ||
component instanceof JCheckBox ||
component instanceof JCheckBoxMenuItem ||
component instanceof JRadioButton ||
component instanceof JRadioButtonMenuItem );
}
/**
* Returns button group used to group toggle state elements placed within container using this layout.
*
* @return button group used to group toggle state elements placed within container using this layout
*/
public UnselectableButtonGroup getButtonGroup ()
{
return buttonGroup;
}
/**
* Returns non-null sides decriptor.
*
* @return non-null sides decriptor
*/
protected String sides ()
{
return sides != null ? sides : ( sides = "1,1,1,1" );
}
/**
* Returns whether or not top side should be decorated.
*
* @return true if top side should be decorated, false otherwise
*/
public boolean isPaintTop ()
{
return sides ().charAt ( 0 ) != '0';
}
/**
* Sets whether or not top side should be decorated.
*
* @param paint whether or not top side should be decorated
*/
public void setPaintTop ( final boolean paint )
{
TextUtils.replace ( sides (), 6, paint ? '1' : '0' );
resetDescriptors ();
}
/**
* Returns whether or not left side should be decorated.
*
* @return true if left side should be decorated, false otherwise
*/
public boolean isPaintLeft ()
{
return sides ().charAt ( 2 ) != '0';
}
/**
* Sets whether or not left side should be decorated.
*
* @param paint whether or not left side should be decorated
*/
public void setPaintLeft ( final boolean paint )
{
TextUtils.replace ( sides (), 6, paint ? '1' : '0' );
resetDescriptors ();
}
/**
* Returns whether or not bottom side should be decorated.
*
* @return true if bottom side should be decorated, false otherwise
*/
public boolean isPaintBottom ()
{
return sides ().charAt ( 4 ) != '0';
}
/**
* Sets whether or not bottom side should be decorated.
*
* @param paint whether or not bottom side should be decorated
*/
public void setPaintBottom ( final boolean paint )
{
TextUtils.replace ( sides (), 6, paint ? '1' : '0' );
resetDescriptors ();
}
/**
* Returns whether or not right side should be decorated.
*
* @return true if right side should be decorated, false otherwise
*/
public boolean isPaintRight ()
{
return sides ().charAt ( 6 ) != '0';
}
/**
* Sets whether or not right side should be decorated.
*
* @param paint whether or not right side should be decorated
*/
public void setPaintRight ( final boolean paint )
{
TextUtils.replace ( sides (), 6, paint ? '1' : '0' );
resetDescriptors ();
}
/**
* Sets whether or not right side should be decorated.
*
* @param top whether or not top side should be decorated
* @param left whether or not bottom side should be decorated
* @param bottom whether or not bottom side should be decorated
* @param right whether or not right side should be decorated
*/
public void setPaintSides ( final boolean top, final boolean left, final boolean bottom, final boolean right )
{
sides = DecorationUtils.toString ( top, left, bottom, right );
resetDescriptors ();
}
@Override
public void addComponent ( final Component component, final Object constraints )
{
// Saving child reference
if ( children == null )
{
children = new WeakHashMap> ( 3 );
}
children.put ( component, new Pair () );
// Updating grouping
if ( isGroupable ( component ) )
{
updateButtonGrouping ();
}
// Resetting descriptors
resetDescriptors ();
}
@Override
public void removeComponent ( final Component component )
{
// Removing child reference
if ( children != null )
{
children.remove ( component );
}
// Updating grouping
if ( isGroupable ( component ) )
{
updateButtonGrouping ();
}
// Resetting descriptors
resetDescriptors ();
}
@Override
public final String getSides ( final Component component )
{
return children != null ? getDescriptors ( component ).getKey () : null;
}
@Override
public final String getLines ( final Component component )
{
return children != null ? getDescriptors ( component ).getValue () : null;
}
/**
* Returns descriptors for painted component sides and lines.
*
* @param component painted component
* @return descriptors for painted component sides and lines
*/
private Pair getDescriptors ( final Component component )
{
Pair pair = children.get ( component );
if ( pair == null || pair.getKey () == null )
{
final Container parent = component.getParent ();
if ( parent != null && isGrouping () )
{
pair = getDescriptors ( parent, component, SwingUtils.indexOf ( parent, component ) );
}
else
{
pair = new Pair ();
}
children.put ( component, pair );
}
return pair;
}
/**
* Returns descriptors for painted component sides and lines.
* It is requested only if grouping is actually enabled.
*
* @param parent component container
* @param component painted component
* @param index component z-index in container
* @return descriptors for painted component sides and lines
*/
protected abstract Pair getDescriptors ( Container parent, Component component, int index );
/**
* Resets cached sides and lines descriptors.
*/
protected void resetDescriptors ()
{
if ( children != null )
{
for ( final Map.Entry> entry : children.entrySet () )
{
entry.setValue ( new Pair () );
}
}
}
}
