net.sf.jasperreports.interactivity.headertoolbar.HeaderToolbarElementUtils Maven / Gradle / Ivy
The newest version!
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2023 Cloud Software Group, 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 sortOrderMapping = new HashMap<>();
static {
sortOrderMapping.put(HeaderToolbarElement.SORT_ORDER_ASC, SortOrderEnum.ASCENDING);
sortOrderMapping.put(HeaderToolbarElement.SORT_ORDER_DESC, SortOrderEnum.DESCENDING);
}
public static String[] extractColumnInfo(String sortColumn) {
return sortColumn.split(HeaderToolbarElement.SORT_COLUMN_TOKEN_SEPARATOR);
}
public static String packSortColumnInfo(String columnName, String columnType, String sortOrder) {
StringBuilder sb = new StringBuilder();
sb.append(columnName)
.append(HeaderToolbarElement.SORT_COLUMN_TOKEN_SEPARATOR)
.append(columnType)
.append(HeaderToolbarElement.SORT_COLUMN_TOKEN_SEPARATOR)
.append(sortOrder);
return sb.toString();
}
public static boolean isValidSortData(String sortData) {
return sortData != null
&& sortData.indexOf(HeaderToolbarElement.SORT_COLUMN_TOKEN_SEPARATOR) >= 0
&& sortData.split(HeaderToolbarElement.SORT_COLUMN_TOKEN_SEPARATOR).length > 1;
}
public static SortOrderEnum getSortOrder(String sortOrder) {
return sortOrderMapping.get(sortOrder);
}
/**
* @deprecated Replaced by {@link FilterTypesEnum#getFilterType(Class)}.
*/
public static FilterTypesEnum getFilterType(Class clazz) {
return FilterTypesEnum.getFilterType(clazz);
}
public static void copyOwnTextElementStyle(EditTextElementData textElementData, JRDesignTextElement textElement, Locale locale) {
textElementData.setFontName(textElement.getOwnFontName());
textElementData.setFontSize(textElement.getOwnFontSize() != null ? NumberFormat.getNumberInstance(locale).format(textElement.getOwnFontSize()) : null);
textElementData.setFloatFontSize(textElement.getOwnFontSize() != null ? textElement.getOwnFontSize() : null);
textElementData.setFontBold(textElement.isOwnBold());
textElementData.setFontItalic(textElement.isOwnItalic());
textElementData.setFontUnderline(textElement.isOwnUnderline());
textElementData.setFontColor(textElement.getOwnForecolor() != null ? JRColorUtil.getColorHexa(textElement.getOwnForecolor()) : null);
textElementData.setFontBackColor(textElement.getOwnBackcolor() != null ? JRColorUtil.getColorHexa(textElement.getOwnBackcolor()) : null);
textElementData.setFontHAlign(textElement.getOwnHorizontalTextAlign() != null ? textElement.getOwnHorizontalTextAlign().getName() : null);
textElementData.setMode(textElement.getOwnMode() != null ? textElement.getOwnMode().getName() : null);
if (textElement instanceof JRDesignTextField && TableUtil.hasSingleChunkExpression((JRDesignTextField) textElement)) {
textElementData.setFormatPattern(((JRDesignTextField) textElement).getOwnPattern());
}
}
public static void copyTextElementStyle(EditTextElementData textElementData, JRDesignTextElement textElement, Locale locale) {
textElementData.setFontName(JRStringUtil.htmlEncode(textElement.getFontName()));
textElementData.setFontSize(NumberFormat.getNumberInstance(locale).format(textElement.getFontSize()));
textElementData.setFloatFontSize(textElement.getFontSize());
textElementData.setFontBold(textElement.isBold());
textElementData.setFontItalic(textElement.isItalic());
textElementData.setFontUnderline(textElement.isUnderline());
textElementData.setFontColor(JRColorUtil.getColorHexa(textElement.getForecolor()));
textElementData.setFontBackColor(JRColorUtil.getColorHexa(textElement.getBackcolor()));
textElementData.setFontHAlign(textElement.getHorizontalTextAlign().getName());
textElementData.setMode(textElement.getMode().getName());
if (textElement instanceof JRDesignTextField && TableUtil.hasSingleChunkExpression((JRDesignTextField) textElement)) {
textElementData.setFormatPattern(JRStringUtil.htmlEncode(((JRDesignTextField) textElement).getPattern()));
}
}
/**
*
*/
public static void updateFilterData(
FilterData filterData,
String filterPattern,
Locale locale,
TimeZone timeZone
)
{
switch (FilterTypesEnum.getByName(filterData.getFilterType()))
{
case DATE :
case TIME :
{
FormatFactory formatFactory = new DefaultFormatFactory();
DateFormat newDf =
formatFactory.createDateFormat(
filterPattern,
locale,
timeZone
);
newDf.setLenient(false);
DateFormat oldDf =
formatFactory.createDateFormat(
filterData.getFilterPattern(),
filterData.getLocaleCode() == null ? locale : JRDataUtils.getLocale(filterData.getLocaleCode()),
filterData.getTimeZoneId() == null ? timeZone : JRDataUtils.getTimeZone(filterData.getTimeZoneId())
);
oldDf.setLenient(false);
try
{
if (filterData.getFieldValueStart() != null && !filterData.getFieldValueStart().trim().isEmpty())
{
filterData.setFieldValueStart(
newDf.format(oldDf.parse(filterData.getFieldValueStart()))
);
}
if (filterData.getFieldValueEnd() != null && !filterData.getFieldValueEnd().trim().isEmpty())
{
filterData.setFieldValueEnd(
newDf.format(oldDf.parse(filterData.getFieldValueEnd()))
);
}
}
catch (ParseException e)
{
throw new JRRuntimeException(e);
}
break;
}
case NUMERIC :
{
FormatFactory formatFactory = new DefaultFormatFactory();
NumberFormat newNf =
formatFactory.createNumberFormat(
filterPattern,
locale
);
NumberFormat oldNf =
formatFactory.createNumberFormat(
filterData.getFilterPattern(),
filterData.getLocaleCode() == null ? locale : JRDataUtils.getLocale(filterData.getLocaleCode())
);
try
{
if (filterData.getFieldValueStart() != null && !filterData.getFieldValueStart().trim().isEmpty())
{
filterData.setFieldValueStart(
newNf.format(oldNf.parse(filterData.getFieldValueStart()))
);
}
if (filterData.getFieldValueEnd() != null && !filterData.getFieldValueEnd().trim().isEmpty())
{
filterData.setFieldValueEnd(
newNf.format(oldNf.parse(filterData.getFieldValueEnd()))
);
}
}
catch (ParseException e)
{
throw new JRRuntimeException(e);
}
break;
}
default :
}
filterData.setFilterPattern(filterPattern);
filterData.setLocaleCode(JRDataUtils.getLocaleCode(locale));
filterData.setTimeZoneId(JRDataUtils.getTimeZoneId(timeZone));//FIXME only set this for date/time?
}
/**
*
*/
public static ConditionalFormattingData getConditionalFormattingData(
JRDesignTextElement textElement,
JasperReportsContext jasperReportsContext
)
{
ConditionalFormattingData cfd = null;
if (textElement != null)
{
JRPropertiesMap propertiesMap = textElement.getPropertiesMap();
if (
propertiesMap.containsProperty(HeaderToolbarElement.COLUMN_CONDITIONAL_FORMATTING_PROPERTY)
&& propertiesMap.getProperty(HeaderToolbarElement.COLUMN_CONDITIONAL_FORMATTING_PROPERTY) != null
)
{
cfd =
JsonLoader.getInstance(jasperReportsContext).loadObject(
propertiesMap.getProperty(HeaderToolbarElement.COLUMN_CONDITIONAL_FORMATTING_PROPERTY),
ConditionalFormattingData.class
);
}
}
return cfd;
}
/**
*
*/
public static void updateConditionalFormattingData(
ConditionalFormattingData cfd,
String conditionPattern,
Locale locale,
TimeZone timeZone
)
{
switch (FilterTypesEnum.getByName(cfd.getConditionType()))
{
case TEXT :
{
// html encode the conditions for text based columns
for (FormatCondition fc: cfd.getConditions())
{
fc.setConditionStart(JRStringUtil.htmlEncode(fc.getConditionStart()));
}
break;
}
case DATE :
case TIME :
{
FormatFactory formatFactory = new DefaultFormatFactory();
DateFormat newDf =
formatFactory.createDateFormat(
conditionPattern,
locale,
timeZone
);
newDf.setLenient(false);
DateFormat oldDf =
formatFactory.createDateFormat(
cfd.getConditionPattern(),
cfd.getLocaleCode() == null ? locale : JRDataUtils.getLocale(cfd.getLocaleCode()),
cfd.getTimeZoneId() == null ? timeZone : JRDataUtils.getTimeZone(cfd.getTimeZoneId())
);
oldDf.setLenient(false);
try
{
for (FormatCondition fc: cfd.getConditions())
{
if (fc.getConditionStart() != null && !fc.getConditionStart().trim().isEmpty())
{
fc.setConditionStart(
newDf.format(oldDf.parse(fc.getConditionStart()))
);
}
if (fc.getConditionEnd() != null && !fc.getConditionEnd().trim().isEmpty())
{
fc.setConditionEnd(
newDf.format(oldDf.parse(fc.getConditionEnd()))
);
}
}
}
catch (ParseException e)
{
throw new JRRuntimeException(e);
}
break;
}
case NUMERIC :
{
FormatFactory formatFactory = new DefaultFormatFactory();
NumberFormat newNf =
formatFactory.createNumberFormat(
conditionPattern,
locale
);
NumberFormat oldNf =
formatFactory.createNumberFormat(
cfd.getConditionPattern(),
cfd.getLocaleCode() == null ? locale : JRDataUtils.getLocale(cfd.getLocaleCode())
);
try
{
for (FormatCondition fc: cfd.getConditions())
{
if (fc.getConditionStart() != null && !fc.getConditionStart().trim().isEmpty())
{
fc.setConditionStart(
newNf.format(oldNf.parse(fc.getConditionStart()))
);
}
if (fc.getConditionEnd() != null && !fc.getConditionEnd().trim().isEmpty())
{
fc.setConditionEnd(
newNf.format(oldNf.parse(fc.getConditionEnd()))
);
}
}
}
catch (ParseException e)
{
throw new JRRuntimeException(e);
}
break;
}
default :
}
cfd.setConditionPattern(conditionPattern);
cfd.setLocaleCode(JRDataUtils.getLocaleCode(locale));
cfd.setTimeZoneId(JRDataUtils.getTimeZoneId(timeZone));
}
/**
*
*/
public static JRField getField(String name, JRDesignDataset dataSet)
{
JRField found = null;
for (JRField field : dataSet.getFields())
{
if (name.equals(field.getName()))
{
found = field;
break;
}
}
return found;
}
/**
*
*/
public static JRVariable getVariable(String name, JRDesignDataset dataSet)
{
JRVariable found = null;
for (JRVariable var : dataSet.getVariables())
{
if (name.equals(var.getName()))
{
found = var;
break;
}
}
return found;
}
public static String getFilterPattern(
JasperReportsContext jasperReportsContext,
Locale locale,
FilterTypesEnum filterType
)
{
String pattern = null;
switch (filterType)
{
case DATE :
{
pattern = HeaderToolbarElementUtils.getDatePattern(jasperReportsContext, locale);
break;
}
case TIME :
{
pattern = HeaderToolbarElementUtils.getTimePattern(jasperReportsContext, locale);
break;
}
case NUMERIC :
{
pattern = HeaderToolbarElementUtils.getNumberPattern(jasperReportsContext, locale);
break;
}
case TEXT :
default :
{
}
}
return pattern;
}
/**
*
*/
public static String getNumberPattern(JasperReportsContext jrContext, Locale locale)
{
String numberPatternBundleName = JRPropertiesUtil.getInstance(jrContext).getProperty(NUMBER_PATTERN_BUNDLE);
if (numberPatternBundleName == null)
{
numberPatternBundleName = DEFAULT_PATTERNS_BUNDLE;
}
String numberPatternKey = JRPropertiesUtil.getInstance(jrContext).getProperty(NUMBER_PATTERN_KEY);
if (numberPatternKey == null)
{
numberPatternKey = DEFAULT_NUMBER_PATTERN_KEY;
}
return getBundleMessage(numberPatternKey, jrContext, numberPatternBundleName, locale);
}
/**
*
*/
public static String getDatePattern(JasperReportsContext jrContext, Locale locale)
{
String datePatternBundleName = JRPropertiesUtil.getInstance(jrContext).getProperty(DATE_PATTERN_BUNDLE);
if (datePatternBundleName == null)
{
datePatternBundleName = DEFAULT_PATTERNS_BUNDLE;
}
String datePatternKey = JRPropertiesUtil.getInstance(jrContext).getProperty(DATE_PATTERN_KEY);
if (datePatternKey == null)
{
datePatternKey = DEFAULT_DATE_PATTERN_KEY;
}
return getBundleMessage(datePatternKey, jrContext, datePatternBundleName, locale);
}
/**
*
*/
public static String getTimePattern(JasperReportsContext jrContext, Locale locale)
{
String timePatternBundleName = JRPropertiesUtil.getInstance(jrContext).getProperty(TIME_PATTERN_BUNDLE);
if (timePatternBundleName == null)
{
timePatternBundleName = DEFAULT_PATTERNS_BUNDLE;
}
String timePatternKey = JRPropertiesUtil.getInstance(jrContext).getProperty(TIME_PATTERN_KEY);
if (timePatternKey == null)
{
timePatternKey = DEFAULT_TIME_PATTERN_KEY;
}
return getBundleMessage(timePatternKey, jrContext, timePatternBundleName, locale);
}
/**
*
*/
public static String getCalendarDatePattern(JasperReportsContext jrContext, Locale locale)
{
String calendarDatePatternBundleName = JRPropertiesUtil.getInstance(jrContext).getProperty(CALENDAR_DATE_PATTERN_BUNDLE);
if (calendarDatePatternBundleName == null)
{
calendarDatePatternBundleName = DEFAULT_PATTERNS_BUNDLE;
}
String calendarDatePatternKey = JRPropertiesUtil.getInstance(jrContext).getProperty(CALENDAR_DATE_PATTERN_KEY);
if (calendarDatePatternKey == null)
{
calendarDatePatternKey = DEFAULT_CALENDAR_DATE_PATTERN_KEY;
}
return getBundleMessage(calendarDatePatternKey, jrContext, calendarDatePatternBundleName, locale);
}
/**
*
*/
public static String getCalendarTimePattern(JasperReportsContext jrContext, Locale locale)
{
String timePatternBundleName = JRPropertiesUtil.getInstance(jrContext).getProperty(TIME_PATTERN_BUNDLE);
if (timePatternBundleName == null)
{
timePatternBundleName = DEFAULT_PATTERNS_BUNDLE;
}
String calendarTimePatternKey = JRPropertiesUtil.getInstance(jrContext).getProperty(CALENDAR_DATE_TIME_PATTERN_KEY);
if (calendarTimePatternKey == null)
{
calendarTimePatternKey = DEFAULT_CALENDAR_DATE_TIME_PATTERN_KEY;
}
return getBundleMessage(calendarTimePatternKey, jrContext, timePatternBundleName, locale);
}
/**
*
*/
public static String getBundleMessage(String key, JasperReportsContext jasperReportsContext, String bundleName, Locale locale)
{
MessageProvider messageProvider = MessageUtil.getInstance(jasperReportsContext).getMessageProvider(bundleName);
return messageProvider.getMessage(key, null, locale);
}
}