|
| |
|
| java.lang.Object
 org.jfree.report.function.AbstractExpression
org.jfree.report.function.AbstractFunction
org.jfree.report.function.ElementVisibilitySwitchFunction
| ElementVisibilitySwitchFunction | | public class ElementVisibilitySwitchFunction extends AbstractFunction implements PageEventListener(Code) | | A function that alternates between true and false for each item within a group. The functions value affects a defined
elements visibility. If the function evaluates to true, the named element is visible, else the element is invisible.
Prior to Version 0.8.9, Elements in the Classic Engine did not define their own background color attribute. To create
a background, one had to place a rectangle shape element behind the element. To modify the band's background
directly, use the
org.jfree.report.function.RowBandingFunction .
The ElementVisibilitySwitchFunction is used to trigger the visibility of an named element. If the element is your
background, you will get the alternating effect.
The ElementVisibilitySwitchFunction defines two parameters: - element
The name of the element(s) in the
itemband that should be modified. The element(s) must be named using the "name" attribute. - initial-state
The initial state of the function. (true or false)
defaults to false. This is the reverse of the element's visiblity (set to false to start with an visible element, set
to true to hide the element in the first itemrow).
author:
Thomas Morgner
author:
Michael D'Amour |
| Method Summary | |
| public String | getElement()
Returns the element name. | | public boolean | getInitialState()
Returns the initial visibility that is used on the start of a new report, a new group or a new page. | | public boolean | getInitialTriggerValue()
Gets the initial value for the visible trigger, either "true" or "false". | | public Boolean | getNewPageState()
Returns the visibility state that should be used on new pages. | | public int | getNumberOfElements()
Returns the number of rows that must be processed before the visibility can switch again. | | public Object | getValue()
Returns the defined visibility of the element. | | public void | itemsAdvanced(ReportEvent event)
Triggers the visibility of an element. | | public void | itemsStarted(ReportEvent event)
Receives notification that the items are being processed. | | public void | pageFinished(ReportEvent event)
Receives notification that a page is completed. | | public void | pageStarted(ReportEvent event)
Receives notification that a page has started. | | public void | reportInitialized(ReportEvent event)
Receives notification that report generation initializes the current run. | | public void | setElement(String name)
Sets the element name. | | public void | setInitialState(boolean initialState)
Defines the initial visibility that is used on the start of a new report, a new group or a new page. | | public void | setNewPageState(Boolean newPageState)
Defines the visibility state that should be used on new pages. | | public void | setNumberOfElements(int numberOfElements)
Defines the number of rows that must be processed before the visibility can switch again. |
| ElementVisibilitySwitchFunction | | public ElementVisibilitySwitchFunction()(Code) | | Default constructor.
|
| getInitialState | | public boolean getInitialState()(Code) | | Returns the initial visibility that is used on the start of a new report, a new group or a new page.
the initial value for the trigger. |
| getInitialTriggerValue | | public boolean getInitialTriggerValue()(Code) | | Gets the initial value for the visible trigger, either "true" or "false".
the initial value for the trigger. |
| getNewPageState | | public Boolean getNewPageState()(Code) | | Returns the visibility state that should be used on new pages. This is only used if resetOnPageStart is set
to true. If this value is not defined, the initialState is used.
the state on new pages. |
| getNumberOfElements | | public int getNumberOfElements()(Code) | | Returns the number of rows that must be processed before the visibility can switch again.
a row count. |
| getValue | | public Object getValue()(Code) | | Returns the defined visibility of the element. Returns either true or false as java.lang.Boolean.
the visibility of the element, either Boolean.TRUE or Boolean.FALSE. |
| itemsAdvanced | | public void itemsAdvanced(ReportEvent event)(Code) | | Triggers the visibility of an element. If the named element was visible at the last itemsAdvanced call, it gets now
invisible and vice versa. This creates the effect, that an element is printed every other line.
Parameters:
event - the report event. |
| itemsStarted | | public void itemsStarted(ReportEvent event)(Code) | | Receives notification that the items are being processed. Sets the function value to false. Following this
event, there will be a sequence of itemsAdvanced events until the itemsFinished event is raised.
Parameters:
event - Information about the event. |
| pageFinished | | public void pageFinished(ReportEvent event)(Code) | | Receives notification that a page is completed.
Parameters:
event - The event. |
| pageStarted | | public void pageStarted(ReportEvent event)(Code) | | Receives notification that a page has started.
Parameters:
event - the event. |
| reportInitialized | | public void reportInitialized(ReportEvent event)(Code) | | Receives notification that report generation initializes the current run. The event carries a
ReportState.Started state. Use this to initialize the report.
Parameters:
event - The event. |
| setInitialState | | public void setInitialState(boolean initialState)(Code) | | Defines the initial visibility that is used on the start of a new report, a new group or a new page.
Parameters:
initialState - the initial value for the trigger. |
| setNewPageState | | public void setNewPageState(Boolean newPageState)(Code) | | Defines the visibility state that should be used on new pages. This is only used if resetOnPageStart is set
to true. If this value is not defined, the initialState is used.
Parameters:
newPageState - the state on new pages or null to use the initialState. |
| setNumberOfElements | | public void setNumberOfElements(int numberOfElements)(Code) | | Defines the number of rows that must be processed before the visibility can switch again.
Parameters:
numberOfElements - a row count. |
|
|
|