Package net.sf.jasperreports.engine.base
Class JRBaseStyle
- java.lang.Object
-
- net.sf.jasperreports.engine.base.JRBaseStyle
-
- All Implemented Interfaces:
Serializable
,Cloneable
,Deduplicable
,JRChangeEventsSupport
,JRBoxContainer
,JRCloneable
,JRParagraphContainer
,JRPenContainer
,JRStyle
,JRStyleContainer
- Direct Known Subclasses:
JRBaseConditionalStyle
,JRDesignStyle
public class JRBaseStyle extends Object implements JRStyle, Serializable, JRChangeEventsSupport, Deduplicable
- Author:
- Ionut Nedelcu (ionutned@users.sourceforge.net)
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from interface net.sf.jasperreports.engine.JRStyle
PROPERTY_EVALUATION_TIME_ENABLED
-
-
Constructor Summary
Constructors Constructor Description JRBaseStyle()
JRBaseStyle(String name)
JRBaseStyle(JRDefaultStyleProvider defaultStyleProvider)
JRBaseStyle(JRDefaultStyleProvider defaultStyleProvider, String name)
JRBaseStyle(JRStyle style, JRAbstractObjectFactory factory)
-
Method Summary
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer
getStyleName
-
-
-
-
Field Detail
-
EXCEPTION_MESSAGE_KEY_CIRCULAR_DEPENDENCY
public static final String EXCEPTION_MESSAGE_KEY_CIRCULAR_DEPENDENCY
- See Also:
- Constant Field Values
-
PROPERTY_BACKCOLOR
public static final String PROPERTY_BACKCOLOR
- See Also:
- Constant Field Values
-
PROPERTY_BLANK_WHEN_NULL
public static final String PROPERTY_BLANK_WHEN_NULL
- See Also:
- Constant Field Values
-
PROPERTY_BOLD
public static final String PROPERTY_BOLD
- See Also:
- Constant Field Values
-
PROPERTY_FILL
public static final String PROPERTY_FILL
- See Also:
- Constant Field Values
-
PROPERTY_FONT_NAME
public static final String PROPERTY_FONT_NAME
- See Also:
- Constant Field Values
-
PROPERTY_FONT_SIZE
public static final String PROPERTY_FONT_SIZE
- See Also:
- Constant Field Values
-
PROPERTY_FORECOLOR
public static final String PROPERTY_FORECOLOR
- See Also:
- Constant Field Values
-
PROPERTY_HORIZONTAL_TEXT_ALIGNMENT
public static final String PROPERTY_HORIZONTAL_TEXT_ALIGNMENT
- See Also:
- Constant Field Values
-
PROPERTY_HORIZONTAL_IMAGE_ALIGNMENT
public static final String PROPERTY_HORIZONTAL_IMAGE_ALIGNMENT
- See Also:
- Constant Field Values
-
PROPERTY_ITALIC
public static final String PROPERTY_ITALIC
- See Also:
- Constant Field Values
-
PROPERTY_MODE
public static final String PROPERTY_MODE
- See Also:
- Constant Field Values
-
PROPERTY_PATTERN
public static final String PROPERTY_PATTERN
- See Also:
- Constant Field Values
-
PROPERTY_PDF_EMBEDDED
public static final String PROPERTY_PDF_EMBEDDED
- See Also:
- Constant Field Values
-
PROPERTY_PDF_ENCODING
public static final String PROPERTY_PDF_ENCODING
- See Also:
- Constant Field Values
-
PROPERTY_PDF_FONT_NAME
public static final String PROPERTY_PDF_FONT_NAME
- See Also:
- Constant Field Values
-
PROPERTY_RADIUS
public static final String PROPERTY_RADIUS
- See Also:
- Constant Field Values
-
PROPERTY_ROTATION
public static final String PROPERTY_ROTATION
- See Also:
- Constant Field Values
-
PROPERTY_SCALE_IMAGE
public static final String PROPERTY_SCALE_IMAGE
- See Also:
- Constant Field Values
-
PROPERTY_STRIKE_THROUGH
public static final String PROPERTY_STRIKE_THROUGH
- See Also:
- Constant Field Values
-
PROPERTY_MARKUP
public static final String PROPERTY_MARKUP
- See Also:
- Constant Field Values
-
PROPERTY_UNDERLINE
public static final String PROPERTY_UNDERLINE
- See Also:
- Constant Field Values
-
PROPERTY_VERTICAL_TEXT_ALIGNMENT
public static final String PROPERTY_VERTICAL_TEXT_ALIGNMENT
- See Also:
- Constant Field Values
-
PROPERTY_VERTICAL_IMAGE_ALIGNMENT
public static final String PROPERTY_VERTICAL_IMAGE_ALIGNMENT
- See Also:
- Constant Field Values
-
defaultStyleProvider
protected final JRDefaultStyleProvider defaultStyleProvider
-
parentStyle
protected JRStyle parentStyle
-
parentStyleNameReference
protected String parentStyleNameReference
-
name
protected String name
-
isDefault
protected boolean isDefault
-
mode
protected ModeEnum mode
-
forecolor
protected Color forecolor
-
backcolor
protected Color backcolor
-
linePen
protected JRPen linePen
-
fill
protected FillEnum fill
-
radius
protected Integer radius
-
scaleImage
protected ScaleImageEnum scaleImage
-
horizontalTextAlign
protected HorizontalTextAlignEnum horizontalTextAlign
-
verticalTextAlign
protected VerticalTextAlignEnum verticalTextAlign
-
horizontalImageAlign
protected HorizontalImageAlignEnum horizontalImageAlign
-
verticalImageAlign
protected VerticalImageAlignEnum verticalImageAlign
-
lineBox
protected JRLineBox lineBox
-
paragraph
protected JRParagraph paragraph
-
fontName
protected String fontName
-
isBold
protected Boolean isBold
-
isItalic
protected Boolean isItalic
-
isUnderline
protected Boolean isUnderline
-
isStrikeThrough
protected Boolean isStrikeThrough
-
fontSize
protected Float fontSize
-
pdfFontName
protected String pdfFontName
-
pdfEncoding
protected String pdfEncoding
-
isPdfEmbedded
protected Boolean isPdfEmbedded
-
rotation
protected RotationEnum rotation
-
markup
protected String markup
-
pattern
protected String pattern
-
isBlankWhenNull
protected Boolean isBlankWhenNull
-
conditionalStyles
protected JRConditionalStyle[] conditionalStyles
-
-
Constructor Detail
-
JRBaseStyle
public JRBaseStyle()
-
JRBaseStyle
public JRBaseStyle(JRDefaultStyleProvider defaultStyleProvider)
-
JRBaseStyle
public JRBaseStyle(String name)
-
JRBaseStyle
public JRBaseStyle(JRDefaultStyleProvider defaultStyleProvider, String name)
-
JRBaseStyle
public JRBaseStyle(JRStyle style, JRAbstractObjectFactory factory)
-
-
Method Detail
-
setParentStyle
protected void setParentStyle(JRStyle parentStyle)
-
checkCircularParent
protected void checkCircularParent()
-
getDefaultStyleProvider
public JRDefaultStyleProvider getDefaultStyleProvider()
- Specified by:
getDefaultStyleProvider
in interfaceJRStyleContainer
-
getStyleResolver
protected StyleResolver getStyleResolver()
-
getStyle
public JRStyle getStyle()
Description copied from interface:JRStyleContainer
Returns this object's style.- Specified by:
getStyle
in interfaceJRStyleContainer
- Returns:
- this object's style
-
getName
public String getName()
Description copied from interface:JRStyle
Gets the style unique name.
-
rename
public void rename(String newName)
Changes the name of this style. Note that this method is mostly meant to be used internally. Use cautiously as it might have unexpected consequences.- Parameters:
newName
- the new name
-
isDefault
public boolean isDefault()
Description copied from interface:JRStyle
Gets a flag that specifies if this is the default report style.
-
getForecolor
public Color getForecolor()
- Specified by:
getForecolor
in interfaceJRStyle
-
getOwnForecolor
public Color getOwnForecolor()
- Specified by:
getOwnForecolor
in interfaceJRStyle
-
getBackcolor
public Color getBackcolor()
- Specified by:
getBackcolor
in interfaceJRStyle
-
getOwnBackcolor
public Color getOwnBackcolor()
- Specified by:
getOwnBackcolor
in interfaceJRStyle
-
getLinePen
public JRPen getLinePen()
- Specified by:
getLinePen
in interfaceJRStyle
-
getFill
public FillEnum getFill()
Description copied from interface:JRStyle
Indicates the fill type used for this element.
-
getOwnFill
public FillEnum getOwnFill()
- Specified by:
getOwnFill
in interfaceJRStyle
-
getRadius
public Integer getRadius()
Description copied from interface:JRStyle
Indicates the corner radius for rectangles with round corners. The default is 0.
-
getOwnRadius
public Integer getOwnRadius()
- Specified by:
getOwnRadius
in interfaceJRStyle
-
getScaleImage
public ScaleImageEnum getScaleImage()
Description copied from interface:JRStyle
Gets the image scale type.- Specified by:
getScaleImage
in interfaceJRStyle
- Returns:
- one of the scale types defined in
ScaleImageEnum
-
getOwnScaleImage
public ScaleImageEnum getOwnScaleImage()
Description copied from interface:JRStyle
Gets the image own scale type.- Specified by:
getOwnScaleImage
in interfaceJRStyle
- Returns:
- one of the scale types defined in
ScaleImageEnum
-
getHorizontalTextAlign
public HorizontalTextAlignEnum getHorizontalTextAlign()
Description copied from interface:JRStyle
Gets the horizontal text alignment of the element.- Specified by:
getHorizontalTextAlign
in interfaceJRStyle
- Returns:
- one of the alignment values defined in
HorizontalTextAlignEnum
-
getOwnHorizontalTextAlign
public HorizontalTextAlignEnum getOwnHorizontalTextAlign()
- Specified by:
getOwnHorizontalTextAlign
in interfaceJRStyle
-
getVerticalTextAlign
public VerticalTextAlignEnum getVerticalTextAlign()
Description copied from interface:JRStyle
Gets the vertical text alignment of the element.- Specified by:
getVerticalTextAlign
in interfaceJRStyle
- Returns:
- one of the alignment values defined in
VerticalTextAlignEnum
-
getOwnVerticalTextAlign
public VerticalTextAlignEnum getOwnVerticalTextAlign()
- Specified by:
getOwnVerticalTextAlign
in interfaceJRStyle
-
getHorizontalImageAlign
public HorizontalImageAlignEnum getHorizontalImageAlign()
Description copied from interface:JRStyle
Gets the horizontal image alignment of the element.- Specified by:
getHorizontalImageAlign
in interfaceJRStyle
- Returns:
- one of the alignment values defined in
HorizontalImageAlignEnum
-
getOwnHorizontalImageAlign
public HorizontalImageAlignEnum getOwnHorizontalImageAlign()
- Specified by:
getOwnHorizontalImageAlign
in interfaceJRStyle
-
getVerticalImageAlign
public VerticalImageAlignEnum getVerticalImageAlign()
Description copied from interface:JRStyle
Gets the vertical image alignment of the element.- Specified by:
getVerticalImageAlign
in interfaceJRStyle
- Returns:
- one of the alignment values defined in
VerticalImageAlignEnum
-
getOwnVerticalImageAlign
public VerticalImageAlignEnum getOwnVerticalImageAlign()
- Specified by:
getOwnVerticalImageAlign
in interfaceJRStyle
-
getLineBox
public JRLineBox getLineBox()
- Specified by:
getLineBox
in interfaceJRBoxContainer
-
getParagraph
public JRParagraph getParagraph()
- Specified by:
getParagraph
in interfaceJRParagraphContainer
-
getRotation
public RotationEnum getRotation()
Description copied from interface:JRStyle
Gets the text rotation.- Specified by:
getRotation
in interfaceJRStyle
- Returns:
- a value representing one of the rotation values in the
RotationEnum
.
-
getOwnRotation
public RotationEnum getOwnRotation()
Description copied from interface:JRStyle
Gets the text own rotation.- Specified by:
getOwnRotation
in interfaceJRStyle
- Returns:
- a value representing one of the rotation values in the
RotationEnum
.
-
setRotation
public void setRotation(RotationEnum rotation)
- Specified by:
setRotation
in interfaceJRStyle
-
getMarkup
public String getMarkup()
Description copied from interface:JRStyle
Returns the markup language used to format the text.
-
getOwnMarkup
public String getOwnMarkup()
- Specified by:
getOwnMarkup
in interfaceJRStyle
-
isBlankWhenNull
public Boolean isBlankWhenNull()
- Specified by:
isBlankWhenNull
in interfaceJRStyle
-
isOwnBlankWhenNull
public Boolean isOwnBlankWhenNull()
- Specified by:
isOwnBlankWhenNull
in interfaceJRStyle
-
getFontName
public String getFontName()
- Specified by:
getFontName
in interfaceJRStyle
-
getOwnFontName
public String getOwnFontName()
- Specified by:
getOwnFontName
in interfaceJRStyle
-
isOwnItalic
public Boolean isOwnItalic()
- Specified by:
isOwnItalic
in interfaceJRStyle
-
isUnderline
public Boolean isUnderline()
- Specified by:
isUnderline
in interfaceJRStyle
-
isOwnUnderline
public Boolean isOwnUnderline()
- Specified by:
isOwnUnderline
in interfaceJRStyle
-
isStrikeThrough
public Boolean isStrikeThrough()
- Specified by:
isStrikeThrough
in interfaceJRStyle
-
isOwnStrikeThrough
public Boolean isOwnStrikeThrough()
- Specified by:
isOwnStrikeThrough
in interfaceJRStyle
-
getFontSize
public Float getFontSize()
- Specified by:
getFontSize
in interfaceJRStyle
-
getOwnFontSize
public Float getOwnFontSize()
- Specified by:
getOwnFontSize
in interfaceJRStyle
-
getPdfFontName
public String getPdfFontName()
- Specified by:
getPdfFontName
in interfaceJRStyle
-
getOwnPdfFontName
public String getOwnPdfFontName()
- Specified by:
getOwnPdfFontName
in interfaceJRStyle
-
getPdfEncoding
public String getPdfEncoding()
- Specified by:
getPdfEncoding
in interfaceJRStyle
-
getOwnPdfEncoding
public String getOwnPdfEncoding()
- Specified by:
getOwnPdfEncoding
in interfaceJRStyle
-
isPdfEmbedded
public Boolean isPdfEmbedded()
- Specified by:
isPdfEmbedded
in interfaceJRStyle
-
isOwnPdfEmbedded
public Boolean isOwnPdfEmbedded()
- Specified by:
isOwnPdfEmbedded
in interfaceJRStyle
-
getPattern
public String getPattern()
Description copied from interface:JRStyle
Gets the pattern used for this text field. The pattern will be used in a SimpleDateFormat for dates and a DecimalFormat for numeric text fields. The pattern format must follow one of these two classes formatting rules, as specified in the JDK API docs.- Specified by:
getPattern
in interfaceJRStyle
- Returns:
- a string containing the pattern.
-
getOwnPattern
public String getOwnPattern()
- Specified by:
getOwnPattern
in interfaceJRStyle
-
getMode
public ModeEnum getMode()
Description copied from interface:JRStyle
Returns the element transparency mode. The default value depends on the type of the report element. Graphic elements like rectangles and lines are opaque by default, but the images are transparent. Both static texts and text fields are transparent by default, and so are the subreport elements.
-
getOwnMode
public ModeEnum getOwnMode()
- Specified by:
getOwnMode
in interfaceJRStyle
-
setForecolor
public void setForecolor(Color forecolor)
- Specified by:
setForecolor
in interfaceJRStyle
-
setBackcolor
public void setBackcolor(Color backcolor)
- Specified by:
setBackcolor
in interfaceJRStyle
-
setScaleImage
public void setScaleImage(ScaleImageEnum scaleImage)
- Specified by:
setScaleImage
in interfaceJRStyle
-
setHorizontalImageAlign
public void setHorizontalImageAlign(HorizontalImageAlignEnum horizontalImageAlign)
- Specified by:
setHorizontalImageAlign
in interfaceJRStyle
-
setVerticalImageAlign
public void setVerticalImageAlign(VerticalImageAlignEnum verticalImageAlign)
- Specified by:
setVerticalImageAlign
in interfaceJRStyle
-
setHorizontalTextAlign
public void setHorizontalTextAlign(HorizontalTextAlignEnum horizontalTextAlign)
- Specified by:
setHorizontalTextAlign
in interfaceJRStyle
-
setVerticalTextAlign
public void setVerticalTextAlign(VerticalTextAlignEnum verticalTextAlign)
- Specified by:
setVerticalTextAlign
in interfaceJRStyle
-
setFontName
public void setFontName(String fontName)
- Specified by:
setFontName
in interfaceJRStyle
-
setPdfEmbedded
public void setPdfEmbedded(Boolean pdfEmbedded)
- Specified by:
setPdfEmbedded
in interfaceJRStyle
-
setStrikeThrough
public void setStrikeThrough(Boolean strikeThrough)
- Specified by:
setStrikeThrough
in interfaceJRStyle
-
setBlankWhenNull
public void setBlankWhenNull(Boolean isBlankWhenNull)
- Specified by:
setBlankWhenNull
in interfaceJRStyle
-
setUnderline
public void setUnderline(Boolean underline)
- Specified by:
setUnderline
in interfaceJRStyle
-
setPattern
public void setPattern(String pattern)
- Specified by:
setPattern
in interfaceJRStyle
-
setPdfEncoding
public void setPdfEncoding(String pdfEncoding)
- Specified by:
setPdfEncoding
in interfaceJRStyle
-
setPdfFontName
public void setPdfFontName(String pdfFontName)
- Specified by:
setPdfFontName
in interfaceJRStyle
-
setFontSize
public void setFontSize(Float fontSize)
- Specified by:
setFontSize
in interfaceJRStyle
-
getConditionalStyles
public JRConditionalStyle[] getConditionalStyles()
- Specified by:
getConditionalStyles
in interfaceJRStyle
-
getStyleNameReference
public String getStyleNameReference()
Description copied from interface:JRStyleContainer
Returns the name of an external style which is to be used by this object. External styles are defined intemplates
and are resolved at fill time. This attribute is only effective if no direct style (as returned bygetStyle()
is specified for this object.- Specified by:
getStyleNameReference
in interfaceJRStyleContainer
- Returns:
- the name of an external style
-
getDefaultLineWidth
public Float getDefaultLineWidth()
- Specified by:
getDefaultLineWidth
in interfaceJRPenContainer
-
getDefaultLineColor
public Color getDefaultLineColor()
- Specified by:
getDefaultLineColor
in interfaceJRBoxContainer
- Specified by:
getDefaultLineColor
in interfaceJRPenContainer
-
getEventSupport
public JRPropertyChangeSupport getEventSupport()
Description copied from interface:JRChangeEventsSupport
Returns the property change support object for this instance.- Specified by:
getEventSupport
in interfaceJRChangeEventsSupport
- Returns:
- the property change support object for this instance
-
clone
public Object clone()
- Specified by:
clone
in interfaceJRCloneable
- Overrides:
clone
in classObject
-
getHashCode
public int getHashCode()
Description copied from interface:Deduplicable
Returns a hash code to be used for the deduplicate map. The returned hash code should be consitent wiwhDeduplicable.isIdentical(Object)
, i.e. if two objects are identical they should have the same hash code.- Specified by:
getHashCode
in interfaceDeduplicable
- Returns:
- deduplication hash code
-
addStyleHash
protected void addStyleHash(ObjectUtils.HashCode hash)
-
isIdentical
public boolean isIdentical(Object object)
Description copied from interface:Deduplicable
Determines if this instance is identical to another object.- Specified by:
isIdentical
in interfaceDeduplicable
- Parameters:
object
- the object to compare with this instance- Returns:
true
if the two objects are identical and can be deduplicated
-
identicalStyle
protected boolean identicalStyle(JRBaseStyle style)
-
-