Package org.pentaho.reporting.engine.classic.core.function

Class ElementVisibilitySwitchFunction

  • All Implemented Interfaces:
    Serializable, Cloneable, EventListener, PageEventListener, ReportListener, Expression, Function, LayoutProcessorFunction
    public class ElementVisibilitySwitchFunction
extends AbstractFunction
implements PageEventListener, LayoutProcessorFunction
    Deprecated.
    Use the RowBandingFunction to modify the band's background color directly.
    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 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, Michael D'Amour
    See Also:
    Serialized Form

    • Constructor Detail

      • ElementVisibilitySwitchFunction

        public ElementVisibilitySwitchFunction()
        Deprecated.
        Default constructor.

    • Method Detail

      • pageStarted

        public void pageStarted​(ReportEvent event)
        Deprecated.
        Receives notification that a page has started.
        Specified by:
        pageStarted in interface PageEventListener
        Parameters:
        event - the event.

      • pageFinished

        public void pageFinished​(ReportEvent event)
        Deprecated.
        Receives notification that a page is completed.
        Specified by:
        pageFinished in interface PageEventListener
        Parameters:
        event - The event.

      • reportInitialized

        public void reportInitialized​(ReportEvent event)
        Deprecated.
        Receives notification that report generation initializes the current run.

        The event carries a ReportState.Started state. Use this to initialize the report.

        Specified by:
        reportInitialized in interface ReportListener
        Overrides:
        reportInitialized in class AbstractFunction
        Parameters:
        event - The event.

      • itemsStarted

        public void itemsStarted​(ReportEvent event)
        Deprecated.
        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.

        Specified by:
        itemsStarted in interface ReportListener
        Overrides:
        itemsStarted in class AbstractFunction
        Parameters:
        event - Information about the event.

      • itemsAdvanced

        public void itemsAdvanced​(ReportEvent event)
        Deprecated.
        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.
        Specified by:
        itemsAdvanced in interface ReportListener
        Overrides:
        itemsAdvanced in class AbstractFunction
        Parameters:
        event - the report event.

      • getNumberOfElements

        public int getNumberOfElements()
        Deprecated.
        Returns the number of rows that must be processed before the visibility can switch again.
        Returns:
        a row count.

      • setNumberOfElements

        public void setNumberOfElements​(int numberOfElements)
        Deprecated.
        Defines the number of rows that must be processed before the visibility can switch again.
        Parameters:
        numberOfElements - a row count.

      • getInitialTriggerValue

        public boolean getInitialTriggerValue()
        Deprecated.
        use getInitialState instead.
        Gets the initial value for the visible trigger, either "true" or "false".
        Returns:
        the initial value for the trigger.

      • getInitialState

        public boolean getInitialState()
        Deprecated.
        Returns the initial visibility that is used on the start of a new report, a new group or a new page.
        Returns:
        the initial value for the trigger.

      • setInitialState

        public void setInitialState​(boolean initialState)
        Deprecated.
        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.

      • getElement

        public String getElement()
        Deprecated.
        Returns the element name.
        Returns:
        The element name.
        See Also:
        setElement(String)

      • getNewPageState

        public Boolean getNewPageState()
        Deprecated.
        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.
        Returns:
        the state on new pages.

      • setNewPageState

        public void setNewPageState​(Boolean newPageState)
        Deprecated.
        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.

      • getValue

        public Object getValue()
        Deprecated.
        Returns the defined visibility of the element. Returns either true or false as java.lang.Boolean.
        Specified by:
        getValue in interface Expression
        Returns:
        the visibility of the element, either Boolean.TRUE or Boolean.FALSE.