ComponentCanvas.java

/*******************************************************************************
 * Copyright 2017 Capital One Services, LLC and Bitwise, Inc.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************/

 
package hydrograph.ui.common.interfaces.tooltip;

import hydrograph.ui.tooltip.tooltips.ComponentTooltip;

import org.eclipse.swt.graphics.Rectangle;
import org.eclipse.swt.widgets.Control;


/**
 * The Interface ComponentCanvas.
 * Base interface for Component tooltip related tasks on Hydrograph Canvas.
 * 
 * @author Bitwise
 */
public interface ComponentCanvas {
	/**
	 * 
	 * Returns Canvas control
	 * 
	 * @return {@link Control}
	 */
	public Control getCanvasControl();
	
	/**
	 * 
	 * Provide tooltip objects for figures which will be drawn on canvas
	 * 
	 * @param componentTooltip
	 * @param componentBounds
	 */
	public void issueToolTip(ComponentTooltip componentTooltip,Rectangle componentBounds);
	
	/**
	 * 
	 * Get component tooltip
	 * 
	 * @return @{link ComponentTooltip}
	 */
	public ComponentTooltip getComponentTooltip();
	
	/**
	 * 
	 * returns true if canvas is focused
	 * 
	 * @return boolean
	 */
	public boolean isFocused();
}