org.jfree.report.function: public class: ElementVisibilitySwitchFunction

org.jfree.report.function
public class: ElementVisibilitySwitchFunction [javadoc | source]

java.lang.Object
   org.jfree.report.function.AbstractExpression
      org.jfree.report.function.AbstractFunction
         org.jfree.report.function.ElementVisibilitySwitchFunction

All Implemented Interfaces:
LayoutProcessorFunction, PageEventListener, Function, Expression, Serializable

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 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

Constructor:
public ElementVisibilitySwitchFunction() { numberOfElements = 1; resetOnGroupStart = true; resetOnPageStart = true; } Default constructor.

Constructor:

 public ElementVisibilitySwitchFunction() {
    numberOfElements = 1;
    resetOnGroupStart = true;
    resetOnPageStart = true;
}

Default constructor.

Method from org.jfree.report.function.ElementVisibilitySwitchFunction Summary:
getElement, getInitialState, getInitialTriggerValue, getNewPageState, getNumberOfElements, getValue, itemsAdvanced, itemsStarted, pageFinished, pageStarted, reportInitialized, setElement, setInitialState, setNewPageState, setNumberOfElements

Methods from org.jfree.report.function.AbstractFunction:
groupFinished, groupStarted, itemsAdvanced, itemsFinished, itemsStarted, reportDone, reportFinished, reportInitialized, reportStarted

Methods from org.jfree.report.function.AbstractExpression:
clone, getDataRow, getDependencyLevel, getInstance, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setActive, setDependencyLevel, setName, setPreserve, setRuntime

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.jfree.report.function.ElementVisibilitySwitchFunction Detail:
public String getElement() { return element; } Deprecated! Returns the element name.
public boolean getInitialState() { return initialState; } Deprecated! Returns the initial visibility that is used on the start of a new report, a new group or a new page.
public boolean getInitialTriggerValue() { return initialState; } Deprecated! `use` - getInitialState instead. Deprecated! Gets the initial value for the visible trigger, either "true" or "false".
public Boolean getNewPageState() { return newPageState; } 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.
public int getNumberOfElements() { return numberOfElements; } Deprecated! Returns the number of rows that must be processed before the visibility can switch again.
public Object getValue() { if (trigger) { return Boolean.TRUE; } else { return Boolean.FALSE; } } Deprecated! Returns the defined visibility of the element. Returns either true or false as java.lang.Boolean.
public void itemsAdvanced(ReportEvent event) { triggerVisibleState(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.
public void itemsStarted(ReportEvent event) { if (resetOnGroupStart) { // pagebreak = false; trigger = !getInitialState(); count = 0; } } 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.
public void pageFinished(ReportEvent event) { } Deprecated! Receives notification that a page is completed.
public void pageStarted(ReportEvent event) { if (resetOnPageStart) { //pagebreak = false; if (newPageState == null) { trigger = getInitialState(); } else { trigger = newPageState.booleanValue(); } count = 0; triggerVisibleState(event); } } Deprecated! Receives notification that a page has started.
public void reportInitialized(ReportEvent event) { //pagebreak = false; trigger = !getInitialState(); count = 0; } Deprecated! Receives notification that report generation initializes the current run. The event carries a ReportState.Started state. Use this to initialize the report.
public void setElement(String name) { this.element = name; } Deprecated! Sets the element name. The name denotes an element or band within the root-band or the root-band itself. It is possible to define multiple elements with the same name to apply the modification to all of these elements.
public void setInitialState(boolean initialState) { this.initialState = initialState; } Deprecated! 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) { this.newPageState = 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.
public void setNumberOfElements(int numberOfElements) { this.numberOfElements = numberOfElements; } Deprecated! Defines the number of rows that must be processed before the visibility can switch again.

Method from org.jfree.report.function.ElementVisibilitySwitchFunction Detail:

 public String getElement() {
    return element;
}

Deprecated!

Returns the element name.

 public boolean getInitialState() {
    return initialState;
}

Deprecated!

Returns the initial visibility that is used on the start of a new report, a new group or a new page.

 public boolean getInitialTriggerValue() {
    return initialState;
}

Deprecated! use - getInitialState instead.

Deprecated!

Gets the initial value for the visible trigger, either "true" or "false".

 public Boolean getNewPageState() {
    return newPageState;
}

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.

 public int getNumberOfElements() {
    return numberOfElements;
}

Deprecated!

Returns the number of rows that must be processed before the visibility can switch again.

 public Object getValue() {
    if (trigger)
    {
      return Boolean.TRUE;
    }
    else
    {
      return Boolean.FALSE;
    }
}

Deprecated!

Returns the defined visibility of the element. Returns either true or false as java.lang.Boolean.

 public  void itemsAdvanced(ReportEvent event) {
    triggerVisibleState(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.

 public  void itemsStarted(ReportEvent event) {
    if (resetOnGroupStart)
    {
      // pagebreak = false;
      trigger = !getInitialState();
      count = 0;
    }
}

Deprecated!

Following this event, there will be a sequence of itemsAdvanced events until the itemsFinished event is raised.

 public  void pageFinished(ReportEvent event) {

}

Deprecated!

Receives notification that a page is completed.

 public  void pageStarted(ReportEvent event) {
    if (resetOnPageStart)
    {
      //pagebreak = false;
      if (newPageState == null)
      {
        trigger = getInitialState();
      }
      else
      {
        trigger = newPageState.booleanValue();
      }
      count = 0;
      triggerVisibleState(event);
    }
}

Deprecated!

Receives notification that a page has started.

 public  void reportInitialized(ReportEvent event) {
    //pagebreak = false;
    trigger = !getInitialState();
    count = 0;
}

Deprecated!

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

 public  void setElement(String name) {
    this.element = name;
}

Deprecated!

Sets the element name. The name denotes an element or band within the root-band or the root-band itself. It is possible to define multiple elements with the same name to apply the modification to all of these elements.

 public  void setInitialState(boolean initialState) {
    this.initialState = initialState;
}

Deprecated!

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) {
    this.newPageState = 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.

 public  void setNumberOfElements(int numberOfElements) {
    this.numberOfElements = numberOfElements;
}

Deprecated!

Defines the number of rows that must be processed before the visibility can switch again.