echopointng.AbleProperties Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ibis-echo2 Show documentation
Echo2 bundled with Echo2_Extras, Echo2_FileTransfer and echopointing and various improvements/bugfixes
There is a newer version: 2.0.4
/* 
 * This file is part of the Echo Point Project.  This project is a collection
 * of Components that have extended the Echo Web Application Framework.
 *
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 */
package echopointng;

import java.io.Serializable;

import nextapp.echo2.app.Alignment;
import nextapp.echo2.app.Component;
import nextapp.echo2.app.FillImage;
import echopointng.able.Alignable;
import echopointng.able.BackgroundImageable;

/**
 * AbleProperties is a collection of UI properties that are related to the
 * various *.able interfaces. This allows you to specify many individual
 * properties in one object.
 * 
 * This class is really design to be used NOT as a fully fledged component in its own right
 * but rather as a holder of specific properties.  Being derived from Component allows
 * it to re-use much of the Style/Property/Rendering code infrastructure of Echo2.
 * 
 * Because AbleProperties is ultimately derived from
 * Component, then you can set properties in here via
 * Style objects. However to get full StyleSheet support,
 * the AbleProperties must be part of the Echo2 component
 * hiearchy.
 */
public class AbleProperties extends AbleComponent implements Serializable, Alignable, BackgroundImageable {

	/**
	 * Constructs a AbleProperties
	 */
	public AbleProperties() {
		super();
	}
	
	/**
	 * We dont allow anu children to be added to the component.
	 * 
	 * @see nextapp.echo2.app.Component#isValidChild(nextapp.echo2.app.Component)
	 */
	public boolean isValidChild(Component child) {
		return false;
	}

	/**
	 * @see echopointng.able.Alignable#getAlignment()
	 */
	public Alignment getAlignment() {
		return (Alignment) getProperty(Alignable.PROPERTY_ALIGNMENT);
	}

	/**
	 * @see echopointng.able.Alignable#setAlignment(nextapp.echo2.app.Alignment)
	 */
	public void setAlignment(Alignment newValue) {
		setProperty(Alignable.PROPERTY_ALIGNMENT, newValue);
	}

	/**
	 * @see echopointng.able.BackgroundImageable#getBackgroundImage()
	 */
	public FillImage getBackgroundImage() {
		return (FillImage) getProperty(BackgroundImageable.PROPERTY_BACKGROUND_IMAGE);
	}

	/**
	 * @see echopointng.able.BackgroundImageable#setBackgroundImage(nextapp.echo2.app.FillImage)
	 */
	public void setBackgroundImage(FillImage newValue) {
		setProperty(BackgroundImageable.PROPERTY_BACKGROUND_IMAGE, newValue);
	}
}