FillingStyle.java

/*
 * This file is part of LaTeXDraw.
 * Copyright (c) 2005-2017 Arnaud BLOUIN
 * LaTeXDraw is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option) any later version.
 * LaTeXDraw is distributed without any warranty; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 */
package net.sf.latexdraw.models.interfaces.shape;

import java.util.Arrays;
import net.sf.latexdraw.view.pst.PSTricksConstants;
import org.eclipse.jdt.annotation.NonNull;

/**
 * The different styles of filling.
 * @author Arnaud Blouin
 */
public enum FillingStyle {
	NONE {
		@Override
		public boolean isFilled() {
			return false;
		}

		@Override
		public String getLatexToken() {
			return PSTricksConstants.TOKEN_FILL_NONE;
		}
	},
	GRAD {
		@Override
		public boolean isFilled() {
			return false;
		}

		@Override
		public String getLatexToken() {
			return PSTricksConstants.TOKEN_FILL_GRADIENT;
		}
	},
	HLINES {
		@Override
		public boolean isFilled() {
			return false;
		}

		@Override
		public String getLatexToken() {
			return PSTricksConstants.TOKEN_FILL_HLINES;
		}
	},
	VLINES {
		@Override
		public boolean isFilled() {
			return false;
		}

		@Override
		public String getLatexToken() {
			return PSTricksConstants.TOKEN_FILL_VLINES;
		}
	},
	CLINES {
		@Override
		public boolean isFilled() {
			return false;
		}

		@Override
		public String getLatexToken() {
			return PSTricksConstants.TOKEN_FILL_CROSSHATCH;
		}
	},
	PLAIN {
		@Override
		public boolean isFilled() {
			return true;
		}

		@Override
		public String getLatexToken() {
			return PSTricksConstants.TOKEN_FILL_SOLID;
		}
	},
	HLINES_PLAIN {
		@Override
		public boolean isFilled() {
			return true;
		}

		@Override
		public String getLatexToken() {
			return PSTricksConstants.TOKEN_FILL_HLINES_F;
		}
	},
	VLINES_PLAIN {
		@Override
		public boolean isFilled() {
			return true;
		}

		@Override
		public String getLatexToken() {
			return PSTricksConstants.TOKEN_FILL_VLINES_F;
		}
	},
	CLINES_PLAIN {
		@Override
		public boolean isFilled() {
			return true;
		}

		@Override
		public String getLatexToken() {
			return PSTricksConstants.TOKEN_FILL_CROSSHATCH_F;
		}
	};

	/**
	 * Allows to know if the style is filled.
	 * @return True if the shape is filled.
	 */
	public abstract boolean isFilled();

	/**
	 * @return The latex token corresponding to the filling style.
	 * @since 3.0
	 */
	public abstract String getLatexToken();

	/**
	 * @param token The style to get.
	 * @return The style which name is the given name style (or null).
	 * @since 3.0
	 */
	public static @NonNull FillingStyle getStyleFromLatex(final String token) {
		return Arrays.stream(values()).filter(style -> style.getLatexToken().equals(token)).findFirst().orElse(NONE);
	}

	/**
	 * @param style The text version of the filling style.
	 * @return The filling style that corresponds to the given text (or null).
	 * @since 3.0
	 */
	public static @NonNull FillingStyle getStyle(final String style) {
		return Arrays.stream(values()).filter(item -> item.toString().equals(style)).findFirst().orElse(NONE);
	}

	/**
	 * @return True if the style is a kind of hatchings.
	 * @since 3.0
	 */
	public boolean isHatchings() {
		return this == HLINES || this == HLINES_PLAIN || this == VLINES || this == VLINES_PLAIN || this == CLINES || this == CLINES_PLAIN;
	}

	/**
	 * @return True if the style is a gradient.
	 * @since 3.0
	 */
	public boolean isGradient() {
		return this == GRAD;
	}
}