001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.ade.galleries.client.preview;
029
030/**
031 * Image format restriction. To be used within the image format tab of the image preview.<p>
032 *
033 * @since 8.0.0
034 */
035public interface I_CmsFormatRestriction {
036
037    /** Value to indicate this dimension is not set. */
038    int DIMENSION_NOT_SET = -1;
039
040    /**
041     * Adjust the given cropping parameter bean to this format restriction.<p>
042     * Execute on selection of this restriction.<p>
043     *
044     * @param croppingParam the cropping parameter bean to adjust
045     */
046    void adjustCroppingParam(CmsCroppingParamBean croppingParam);
047
048    /**
049     * Returns the preset height for this format restriction.<p>
050     *
051     * @param orgHeight the original image height
052     * @param orgWidth the original image width
053     *
054     * @return the height
055     */
056    int getHeight(int orgHeight, int orgWidth);
057
058    /**
059     * Returns the label for the format.<p>
060     *
061     * @return the label
062     */
063    String getLabel();
064
065    /**
066     * Returns the format name.<p>
067     *
068     * @return the format name
069     */
070    String getName();
071
072    /**
073     * Returns the preset width for this format restriction.<p>
074     *
075     * @param orgHeight the original image height
076     * @param orgWidth the original image width
077     *
078     * @return the width
079     */
080    int getWidth(int orgHeight, int orgWidth);
081
082    /**
083     * Returns if this format allows cropping.<p>
084     *
085     * @return <code>true</code> if cropping is allowed
086     */
087    boolean isCroppingEnabled();
088
089    /**
090     * Returns if this format has a fixed height/width ratio.<p>
091     *
092     * @return <code>true</code> if the ratio is fixed
093     */
094    boolean isFixedRatio();
095
096    /**
097     * Returns if height is editable.<p>
098     *
099     * @return <code>true</code> if height is editable
100     */
101    boolean isHeightEditable();
102
103    /**
104     * Returns if width is editable.<p>
105     *
106     * @return <code>true</code> if width is editable
107     */
108    boolean isWidthEditable();
109
110    /**
111     * Checks whether the given cropping parameter matches these restrictions.<p>
112     *
113     * @param croppingParam the cropping parameter to match
114     *
115     * @return <code>true</code> if the restrictions are matched by the given cropping parameter
116     */
117    boolean matchesCroppingParam(CmsCroppingParamBean croppingParam);
118}