Package net.sf.jasperreports.parts.subreport

Class StandardSubreportPartComponent

java.lang.Object
net.sf.jasperreports.parts.subreport.StandardSubreportPartComponent
All Implemented Interfaces:
Serializable, Cloneable, JRChangeEventsSupport, JRCloneable, PartComponent, SubreportPartComponent
public class StandardSubreportPartComponent extends Object implements Serializable, SubreportPartComponent, JRChangeEventsSupport
Standard SubreportPartComponent implementation.
Author:
Lucian Chirita (lucianc@users.sourceforge.net)
See Also:

  • Field Details

  • Constructor Details

    • StandardSubreportPartComponent

      public StandardSubreportPartComponent()

    • StandardSubreportPartComponent

      public StandardSubreportPartComponent(SubreportPartComponent subreport, JRBaseObjectFactory factory)

  • Method Details

    • getUsingCache

      public Boolean getUsingCache()
      Description copied from interface: SubreportPartComponent
      Indicates if the engine is loading the current subreport from cache. Implementations of this method return the actual value for the internal flag that was explicitly set on this subreport.
      Specified by:
      getUsingCache in interface SubreportPartComponent
      Returns:
      Boolean.TRUE if the subreport should be loaded from cache, Boolean.FALSE otherwise or null in case the flag was never explicitly set on this subreport element

    • setUsingCache

      public void setUsingCache(Boolean usingCache)
      Description copied from interface: SubreportPartComponent
      Specifies if the engine should be loading the current subreport from cache. If set to Boolean.TRUE, the reporting engine will try to recognize previously loaded subreports using their specified source. For example, it will recognize an subreport if the subreport source is a file name that it has already loaded, or if it is the same URL.

      If set to null, the engine will rely on some default value which depends on the type of the subreport expression. The cache is turned on by default only for subreports that have java.lang.String objects in their expressions.

      Specified by:
      setUsingCache in interface SubreportPartComponent

    • getParametersMapExpression

      public JRExpression getParametersMapExpression()
      Specified by:
      getParametersMapExpression in interface SubreportPartComponent

    • setParametersMapExpression

      public void setParametersMapExpression(JRExpression parametersMapExpression)

    • getParameters

      public JRSubreportParameter[] getParameters()
      Specified by:
      getParameters in interface SubreportPartComponent

    • getParametersMap

      public Map<String,JRSubreportParameter> getParametersMap()

    • addParameter

      public void addParameter(JRSubreportParameter subreportParameter) throws JRException
      Throws:
      JRException

    • removeParameter

      public JRSubreportParameter removeParameter(String name)

    • addReturnValue

      public void addReturnValue(JRSubreportReturnValue returnValue)
      Adds a return value to the subreport.
      Parameters:
      returnValue - the return value to be added.

    • getReturnValues

      public JRSubreportReturnValue[] getReturnValues()
      Returns the list of values to be copied from the subreport into the master.
      Specified by:
      getReturnValues in interface SubreportPartComponent
      Returns:
      the list of values to be copied from the subreport into the master.

    • getReturnValuesList

      public List<JRSubreportReturnValue> getReturnValuesList()
      Returns the list of values to be copied from the subreport into the master.
      Returns:
      list of JRSubreportReturnValue objects

    • removeReturnValue

      public boolean removeReturnValue(JRSubreportReturnValue returnValue)
      Removes a return value from the subreport.
      Parameters:
      returnValue - the return value to be removed
      Returns:
      true if the return value was found and removed

    • getExpression

      public JRExpression getExpression()
      Specified by:
      getExpression in interface SubreportPartComponent

    • setExpression

      public void setExpression(JRExpression expression)

    • clone

      public Object clone()
      Specified by:
      clone in interface JRCloneable
      Overrides:
      clone in class Object

    • getEventSupport

      public JRPropertyChangeSupport getEventSupport()
      Description copied from interface: JRChangeEventsSupport
      Returns the property change support object for this instance.
      Specified by:
      getEventSupport in interface JRChangeEventsSupport
      Returns:
      the property change support object for this instance