Package net.sf.jasperreports.engine
Interface JRAnchor
-
- All Known Subinterfaces:
ChartSettings,JRChart,JRImage,JRTextField
- All Known Implementing Classes:
FillChartSettings,JRBaseChart,JRBaseImage,JRBaseTextField,JRDesignChart,JRDesignImage,JRDesignTextField,JRFillChart,JRFillImage,JRFillTextField,StandardChartSettings
public interface JRAnchorAn interface providing anchor functionality. It must be implemented by elements that can contain anchors for hyperlinks. If present in a text field or image element declaration, the<anchorNameExpression>tag (seegetAnchorNameExpression()) transforms that particular text field or image into a local anchor of the resulting document, to which hyperlinks can point. The anchor will bear the name returned after evaluation of the anchor name expression, which should always returnjava.lang.Stringvalues.- Author:
- Teodor Danciu (teodord@users.sourceforge.net)
- See Also:
JRHyperlink
-
-
Field Summary
Fields Modifier and Type Field Description static intNO_BOOKMARKValue of the bookmark level that indicates that no bookmark should be created for the anchor.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description JRExpressiongetAnchorNameExpression()Returns an expression whose value represents the anchor name.intgetBookmarkLevel()Returns the level of the bookmark corresponding to the anchor.JRExpressiongetBookmarkLevelExpression()Returns an expression whose value represents the bookmark level (starting from 1) corresponding to this anchor.
-
-
-
Field Detail
-
NO_BOOKMARK
static final int NO_BOOKMARK
Value of the bookmark level that indicates that no bookmark should be created for the anchor.- See Also:
- Constant Field Values
-
-
Method Detail
-
getAnchorNameExpression
JRExpression getAnchorNameExpression()
Returns an expression whose value represents the anchor name.
-
getBookmarkLevelExpression
JRExpression getBookmarkLevelExpression()
Returns an expression whose value represents the bookmark level (starting from 1) corresponding to this anchor. When the expression is set and its value is not null, it will override the value of the bookmarkLevel attribute.
-
getBookmarkLevel
int getBookmarkLevel()
Returns the level of the bookmark corresponding to the anchor.- Returns:
- the level of the bookmark corresponding to the anchor (starting from 1)
or
NO_BOOKMARKif no bookmark should be created for this anchor
-
-