ButtonProvider.java

/*
 * JBoss, Home of Professional Open Source.
 *
 * See the LEGAL.txt file distributed with this work for information regarding copyright ownership and licensing.
 *
 * See the AUTHORS.txt file distributed with this work for a full listing of individual contributors.
 */
package org.teiid.designer.ui.common.widget;

import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.swt.widgets.Button;

/**
 * 
 *
 * @since 8.0
 */
public interface ButtonProvider {
    
    /**
     * @return the image descriptor or <code>null</code>
     */
    ImageDescriptor getImageDescriptor();

    /**
     * @return the {@link Button button's} text
     */
    String getText();
    
    /**
     * @return the {@link Button button's} tooltip (<code>null</code> or empty of no tooltip)
     */
    String getToolTip();

    /**
     * @param selection
     * @return <code>true</code> if the {@link Button button} is enabled
     */
    boolean isEnabled( IStructuredSelection selection );

    /**
     * @param selection
     */
    void selected( IStructuredSelection selection );
}