/**
* Copyright (c) 2003-2009, Xith3D Project Group all rights reserved.
*
* Portions based on the Java3D interface, Copyright by Sun Microsystems.
* Many thanks to the developers of Java3D and Sun Microsystems for their
* innovation and design.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of the 'Xith3D Project Group' nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) A
* RISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE
*/
package org.xith3d.ui.hud.base;
/**
* A Widget implementing this interface can get a padding.
*
* @author Marvin Froehlich (aka Qudus)
*/
public interface PaddingSettable
{
/**
* Sets padding for this PaddingSettable Widget.<br>
* Padding translates local coordinates and shrinks the clipping area.
*
* @param paddingBottom
* @param paddingRight
* @param paddingTop
* @param paddingLeft
*
* @return true, if the padding actually has changed
*/
public boolean setPadding( int paddingBottom, int paddingRight, int paddingTop, int paddingLeft );
/**
* Sets padding for this PaddingSettable Widget.<br>
* Padding translates local coordinates and shrinks the clipping area.
*
* @param padding padding for <i>bottom</i>, <i>right</i>, <i>top</i> and <i>left</i>
*
* @return true, if the padding actually has changed
*/
public boolean setPadding( int padding );
/**
* @return bottom-padding for this PaddingSettable Widget.<br>
* Padding translates local coordinates and shrinks the clipping area.
*/
public int getPaddingBottom();
/**
* @return right-padding for this PaddingSettable Widget.<br>
* Padding translates local coordinates and shrinks the clipping area.
*/
public int getPaddingRight();
/**
* @return top-padding for this PaddingSettable Widget.<br>
* Padding translates local coordinates and shrinks the clipping area.
*/
public int getPaddingTop();
/**
* @return left-padding for this PaddingSettable Widget.<br>
* Padding translates local coordinates and shrinks the clipping area.
*/
public int getPaddingLeft();
}