/*
 * Copyright (c) 2007,2008 Declarative Engineering LLC.
 * All rights reserved.  This program and the accompanying materials
 * are made available under the terms of the Declarative Engineering LLC
 * verson 1 which accompanies this distribution, and is available at
 * http://declarativeengineering.com/legal/DE_Developer_License_v1.txt
 */
package com.foundation.view.swt;

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

import com.foundation.view.AbstractDecoration;

public interface IOverlay {
	public static final int POSITION_UPPER_LEFT = AbstractDecoration.POSITION_UPPER_LEFT;
	public static final int POSITION_UPPER_RIGHT = AbstractDecoration.POSITION_UPPER_RIGHT;
	public static final int POSITION_LOWER_LEFT = AbstractDecoration.POSITION_LOWER_LEFT;
	public static final int POSITION_LOWER_RIGHT = AbstractDecoration.POSITION_LOWER_RIGHT;
/**
 * Gets the peer control that is being overlayed.
 * @return The control the overlay is attached to.
 */
public Control getPeerControl();
/**
 * Gets the horizontal offset.
 * @return The offset (positive is inward) for the overlay.
 */
public int getHorizontalOffset();
/**
 * Gets the vertical offset.
 * @return The offset (positive is inward) for the overlay.
 */
public int getVerticalOffset();
/**
 * Gets which corner the overlay should adorn.
 * @return The corner of the peer control that is being overlayed.
 */
public int getPosition();
/**
 * Gets the size of the overlay.
 * @return The overlay size.
 */
public Point getSize();
}//IOverlay//