org.geomajas.configuration.AbstractReadOnlyAttributeInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of geomajas-api Show documentation
Geomajas server: Main - api
There is a newer version: 1.18.5
/*
 * This is part of Geomajas, a GIS framework, http://www.geomajas.org/.
 *
 * Copyright 2008-2015 Geosparc nv, http://www.geosparc.com/, Belgium.
 *
 * The program is available in open source according to the GNU Affero
 * General Public License. All contributions in this program are covered
 * by the Geomajas Contributors License Agreement. For full licensing
 * details, see LICENSE.txt in the project root.
 */

package org.geomajas.configuration;

import org.geomajas.annotation.Api;

/**
 * Base information which is shared between all read-only attributes.
 *
 * @author Joachim Van der Auwera
 * @author Jan De Moerloose
 * @since 1.10.0 split out of AttributeInfo which is now deprecated
 */
@Api(allMethods = true)
@SuppressWarnings("deprecation")
public abstract class AbstractReadOnlyAttributeInfo extends AttributeInfo {

	private static final long serialVersionUID = 1100L;

	/** No-arguments constructor needed for GWT. */
	public AbstractReadOnlyAttributeInfo() {
		super();
	}

	/**
	 * Get label for attribute.
	 *
	 * @return label
	 * @since 1.13.0 split out of deprecated AttributeInfo.
	 */
	public String getLabel() {
		return super.getLabel();
	}

	/**
	 * Set label for attribute.
	 *
	 * @param label label
	 * @since 1.13.0 split out of deprecated AttributeInfo.
	 */
	public void setLabel(String label) {
		super.setLabel(label);
	}

	/**
	 * Is this an identifying attribute? Is it part of the feature id?
	 *
	 * @return true when attribute is part of the feature id
	 * @since 1.13.0 split out of deprecated AttributeInfo.
	 */
	public boolean isIdentifying() {
		return super.isIdentifying();
	}

	/**
	 * Set whether the attribute is part of the feature id.
	 *
	 * @param identifying true when attribute is part of the feature id
	 * @since 1.13.0 split out of deprecated AttributeInfo.
	 */
	public void setIdentifying(boolean identifying) {
		super.setIdentifying(identifying);
	}

	/**
	 * This value determines whether or not this attribute definition should be hidden in editing forms and other
	 * widgets on the client.
	 * 
	 * The default value for this setting is 'false'.
	 *
	 * @return true when hidden.
	 * @since 1.13.0 split out of deprecated AttributeInfo.
	 */
	public boolean isHidden() {
		return super.isHidden();
	}

	/**
	 * This value determines whether or not this attribute definition should be hidden in editing forms and other
	 * widgets on the client.
	 * 
	 * The default value for this setting is 'false'.
	 *
	 * @param hidden new hidden status.
	 * @since 1.13.0 split out of deprecated AttributeInfo.
	 */
	public void setHidden(boolean hidden) {
		super.setHidden(hidden);
	}
}