net.sf.jasperreports.engine.type.StretchTypeEnum Maven / Gradle / Ivy
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2016 TIBCO Software Inc. All rights reserved.
* http://www.jaspersoft.com
*
* Unless you have purchased a commercial license agreement from Jaspersoft,
* the following license terms apply:
*
* This program is part of JasperReports.
*
* JasperReports is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* JasperReports is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with JasperReports. If not, see
* First, there is the natural stretch of the element, which is caused by the element growing naturally in order to display its entire content.
* This is the case with text fields that have isStretchWithOverflow set to true and thus growing in height in order to display all the rows of text
* that the value of their text field expression provides at runtime.
*
* Secondly, there is the forced stretch of an element, which in addition to its natural growth required by its own content, needs to further grow
* to match the growing height of some other element that it is put in relation with at report design time.
*
* A forced stretch can be imposed to elements that are part of element groups (JRElementGroup) or element containers (bands, frames, table cells, list cells, etc.).
* The forced stretch also comes in two flavors.
*
* There is element group stretch and container stretch.
*
* Element group stretch is forced upon an element by the natural growth of the other elements in the same group.
*
* The container stretch is forced upon an element by all types of growth that the container itself suffers,
* including forced container stretch imposed onto the container by its own parent container.
*
* @author sanda zaharia ([email protected])
*/
public enum StretchTypeEnum implements JREnum
{
/**
* A constant indicating that the element preserves its original specified height.
*/
NO_STRETCH((byte)0, "NoStretch"),//FIXMEENUM check all 0 constants for initialization
/**
* @deprecated Replaced by {@link StretchTypeEnum#ELEMENT_GROUP_HEIGHT}.
*/
@Deprecated
RELATIVE_TO_TALLEST_OBJECT((byte)1, "RelativeToTallestObject"),
/**
* @deprecated Replaced by {@link StretchTypeEnum#CONTAINER_HEIGHT}.
*/
@Deprecated
RELATIVE_TO_BAND_HEIGHT((byte)2, "RelativeToBandHeight"),
/**
* Constant used for specifying that the element will adapt its height to match the changing
* height of the overall element group it is part of, but without taking into account the fact that the Y position of the
* element within the group has probably changed due to floating and/or
* collapsing white space above it. This position change is not compensated for, which might result in the element distance
* to the group's initial bottom edge increasing or diminishing.
*
* Like all element group based types of stretch, the amount of stretch forced onto the element comes only from the natural
* stretch of the sibling elements in the same group.
*/
ELEMENT_GROUP_HEIGHT((byte)3, "ElementGroupHeight"),
/**
* Constant used for specifying that the element will adapt its height to match the changing
* height of the overall element group it is part of, but also taking into account the fact that the Y position of the
* element within the group has probably changed due to floating and/or
* collapsing white space above it and should be compensated for, resulting in the element's distance to the group's initial
* bottom edge being preserved.
*
* Like all element group based types of stretch, the amount of stretch forced onto the element comes only from the natural
* stretch of the sibling elements in the same group.
*/
ELEMENT_GROUP_BOTTOM((byte)3, "ElementGroupBottom"),
/**
* Constant used for specifying that the element will adapt its height to match the new
* height of the container it is placed on, which has been affected by stretch, but without taking
* into account the fact that the Y position of the element within the container has probably changed due to floating and/or
* collapsing white space above it. This position change is not compensated for, which might result in the element distance
* to the container's bottom edge increasing or diminishing. It could even happen that the element bottom edge goes beyond
* container bottom edge and thus the element will no longer render at all.
*
* Like all container based types of stretch, the amount of stretch forced onto the element can come from both the natural
* stretch of the sibling elements in the same container, or from the container's own forced stretch imposed onto it by its own parent container.
*/
CONTAINER_HEIGHT((byte)3, "ContainerHeight"),
/**
* Constant used for specifying that the element will adapt its height to match the new
* height of the container it is placed on, which has been affected by stretch, but also taking
* into account the fact that the Y position of the element has probably changed and should be compensated for,
* resulting in the element's distance to container bottom being preserved.
*
* Like all container based types of stretch, the amount of stretch forced onto the element can come from both the natural
* stretch of the sibling elements in the same container, or from the container's own forced stretch imposed onto it by its own parent container.
*/
CONTAINER_BOTTOM((byte)4, "ContainerBottom");
/**
*
*/
@Property(
category = PropertyConstants.CATEGORY_FILL,
scopes = {PropertyScope.CONTEXT},
sinceVersion = PropertyConstants.VERSION_5_1_2,
valueType = Boolean.class
)
public static final String PROPERTY_LEGACY_ELEMENT_STRETCH_ENABLED =
JRPropertiesUtil.PROPERTY_PREFIX + "legacy.element.stretch.enabled";
/**
*
*/
private final transient byte value;
private final transient String name;
private StretchTypeEnum(byte value, String name)
{
this.value = value;
this.name = name;
}
/**
* @deprecated Used only by deprecated serialized fields.
*/
@Override
public Byte getValueByte()
{
return new Byte(value);
}
/**
* @deprecated Used only by deprecated serialized fields.
*/
@Override
public final byte getValue()
{
return value;
}
@Override
public String getName()
{
return name;
}
/**
*
*/
public static StretchTypeEnum getByName(String name)
{
return EnumUtil.getEnumByName(values(), name);
}
/**
* @deprecated Used only by deprecated serialized fields.
*/
public static StretchTypeEnum getByValue(Byte value)
{
return (StretchTypeEnum)EnumUtil.getByValue(values(), value);
}
/**
* @deprecated Used only by deprecated serialized fields.
*/
public static StretchTypeEnum getByValue(byte value)
{
return getByValue(new Byte(value));
}
}