org.geomajas.sld.xlink.ShowInfo Maven / Gradle / Ivy

Go to download
/*
 * This is part of Geomajas, a GIS framework, http://www.geomajas.org/.
 *
 * Copyright 2008-2013 Geosparc nv, http://www.geosparc.com/, Belgium.
 *
 * The program is available in open source according to the Apache
 * License, Version 2.0. 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.sld.xlink;

import java.io.Serializable;

import org.geomajas.annotation.Api;

/**
 * 
 The 'show' attribute is used to communicate the desired presentation of the ending resource on traversal from the
 * starting resource; it's value should be treated as follows: new - load ending resource in a new window, frame, pane,
 * or other presentation context replace - load the resource in the same window, frame, pane, or other presentation
 * context embed - load ending resource in place of the presentation of the starting resource other - behavior is
 * unconstrained; examine other markup in the link for hints none - behavior is unconstrained
 * 
 * 
 * Schema fragment(s) for this class:...
 * 
 *  * <xs:attribute
 * xmlns:ns="http://www.w3.org/1999/xlink"
 * xmlns:xs="http://www.w3.org/2001/XMLSchema" name="show">
 *   <xs:simpleType>
 *     <!-- Reference to inner class ShowInfoInner -->
 *   </xs:simpleType>
 * </xs:attribute>
 * 
 * 
 * @author Jan De Moerloose
 * @since 1.0.0
 */
@Api(allMethods = true)
public enum ShowInfo implements Serializable {
	/**
	 * Load ending resource in a new window, frame, pane, or other presentation context.
	 */
	NEW("new"),
	/**
	 * Load the resource in the same window, frame, pane, or other presentation context.
	 */
	REPLACE("replace"),
	/**
	 * Load ending resource in place of the presentation of the starting resource.
	 */
	EMBED("embed"),
	/**
	 * Behavior is unconstrained; examine other markup in the link for hints.
	 */
	OTHER("other"),
	/**
	 * Behavior is unconstrained.
	 */
	NONE("none");

	private static final long serialVersionUID = 100;

	private final String value;

	private ShowInfo(String value) {
		this.value = value;
	}

	/**
	 * Get the value of the show attribute.
	 * 
	 * @return the string value
	 */
	public String xmlValue() {
		return value;
	}

	/**
	 * Convert a string to an {@link ShowInfo} object.
	 * 
	 * @param value the string value
	 * @return the object
	 */
	public static ShowInfo convert(String value) {
		for (ShowInfo inst : values()) {
			if (inst.xmlValue().equals(value)) {
				return inst;
			}
		}
		return null;
	}
}