org.jdesktop.swingx.table.ColumnControlPopup Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swingx Show documentation

Contains extensions to the Swing GUI toolkit, including new and enhanced components that provide functionality commonly required by rich client applications.

There is a newer version: 1.6.1

Show newest version

/*
 * Created on 22.06.2006
 *
 */
package org.jdesktop.swingx.table;

import java.awt.ComponentOrientation;
import java.util.List;

import javax.swing.Action;
import javax.swing.JComponent;

import org.jdesktop.swingx.action.AbstractActionExt;

/**
 * Encapsulates the popup component which is the delegate for
 * all popup visuals, used by a ColumnControlButton.
 * 
 * For now, this class a simple extraction of what a ColumnControl needs. 
 * Usage will drive further evolution.
 * 
 */
public interface ColumnControlPopup {

    /**
     * Updates all internal visuals after changing a UI-delegate. 

     * 
     * The method called by ColumnControlButton in it's updateUI.
     * As there is a good probability that at the time of a
     * ColumnControlButton is updated after a ui-delegate change the
     * popup is not visible/part of the container hierarchy, this
     * method must be messaged manually. 
     * 
     * @see javax.swing.JComponent#updateUI()
     *
     */
    void updateUI();

    /**
     * Toggles the popup's visibility. This method is responsible for
     * placing itself relative to the given owner if toggled to visible.
     * 
     * @param owner the JComponent which triggered the visibility change, typically
     *   a ColumnControlButton.
     */
    void toggleVisibility(JComponent owner);

    /**
     * Applies the specified component orientation to all internal widgets.
     * This method must be called by the owner if its component orientation 
     * changes. 
     * 
     * @param o the componentOrientation to apply to all internal widgets.
     * @see javax.swing.JComponent#applyComponentOrientation(ComponentOrientation).
     */
    void applyComponentOrientation(ComponentOrientation o);

    /**
     * Removes all items from the popup. 
     */
    void removeAll();

    /**
     * Adds items corresponding to the column's visibility actions.
     * 
     * Each Action in the list is a stateAction,
     * its selected property bound to a column's
     * visible property, that is toggling the selected will
     * toggle the column's visibility (if the action is enabled).
     * 
     * The  Actions name property is bound to 
     * the column's title.
     * 
     * @param actions List of AbstractActionExt to add.
     */
    void addVisibilityActionItems(List actions);
    // JW: dooohhh ... what a winding description ...
    // sure need to have a better abstraction! 
    // 
    
    /**
     * Adds additional actions to the popup. 
     * 
     * @param actions List of Actions to add to the popup.
     */
    void addAdditionalActionItems(List actions);

}