Style Intelligence v12.0

inetsoft.report
Class ReportEnv

java.lang.Object
  extended by inetsoft.report.ReportEnv

public class ReportEnv
extends Object

The report environment properties class. This class can be used to set property values or access property values. Some aspects of report generation are controlled through properties. Please read the Style Report Programming Guide for available properties.


Constructor Summary
ReportEnv()
           
 
Method Summary
static void clear()
          Clear and reload the properties.
static Boolean getBoolean(String name)
          Get a property as a boolean value.
static double[] getDoubles(String name)
          Get a property as a list of numbers (separated by comma).
static Thread getEventDispatcher()
          Get the AWT event dispatcher.
static Font getFont(String name)
          Get a property as a font.
static Insets getInsets(String name)
          Get a property as an insets.
static Integer getInt(String name)
          Get a property as an integer.
static String getPath(String name, String def)
          Get a property value from specific properties set as a file path.
static Properties getProperties()
          Get the properties object.
static Properties getProperty(inetsoft.util.ReportKey key)
          Get properties.
static String getProperty(String name)
          Get a property value.
static String getProperty(String name, String def)
          Get a property value with a default if the property is not defined.
static void init(Properties prop)
          Use the properties from another application to access configuration information.
static void init(String path)
          Initialize the environment.
static boolean isDesignTime()
          Check if this is running in designer.
static boolean isHandlingEvent()
          Check if event dispatcher is handling event.
static boolean isInitializing()
          Check if is in initializing.
static void setConfigurationHome(String home)
          Set the path of the configuration directory.
static void setDesignTime(boolean flag)
          Set whether this is running in designer.
static void setEventDispatcher(Thread thread)
          Set the AWT event dispatcher.
static void setInitializing(boolean init)
          Set whether is in initializing.
static void setProperty(String name, String val)
          Set the value of a property.
static String substitute(String line, Properties dict)
          Substitute $(name) in the line with the value in dict.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReportEnv

public ReportEnv()
Method Detail

isHandlingEvent

public static boolean isHandlingEvent()
Check if event dispatcher is handling event.


getEventDispatcher

public static Thread getEventDispatcher()
Get the AWT event dispatcher.


setEventDispatcher

public static void setEventDispatcher(Thread thread)
Set the AWT event dispatcher.


getProperty

public static String getProperty(String name)
Get a property value.


getProperty

public static String getProperty(String name,
                                 String def)
Get a property value with a default if the property is not defined.


setProperty

public static void setProperty(String name,
                               String val)
Set the value of a property.


getProperties

public static Properties getProperties()
Get the properties object.


getPath

public static String getPath(String name,
                             String def)
Get a property value from specific properties set as a file path. If the path is not absolute a sree.home is defined, the sree.home is prepended to the file name.

Parameters:
name - property name.
def - default value if the property is null.

setConfigurationHome

public static void setConfigurationHome(String home)
Set the path of the configuration directory. This should only be called if an application needs to explicitly control the location and is not using the standard deployment configuration parameters.


getFont

public static Font getFont(String name)
Get a property as a font. The property must be a valid font string created by StyleFont.toString().


substitute

public static String substitute(String line,
                                Properties dict)
Substitute $(name) in the line with the value in dict.


init

public static void init(String path)
                 throws IOException
Initialize the environment.

Parameters:
path - the initial property file path.
Throws:
IOException

init

public static void init(Properties prop)
Use the properties from another application to access configuration information.


setDesignTime

public static void setDesignTime(boolean flag)
Set whether this is running in designer.


isDesignTime

public static boolean isDesignTime()
Check if this is running in designer.


clear

public static void clear()
Clear and reload the properties.


getProperty

public static Properties getProperty(inetsoft.util.ReportKey key)
Get properties.


isInitializing

public static boolean isInitializing()
Check if is in initializing.


setInitializing

public static void setInitializing(boolean init)
Set whether is in initializing.


getInsets

public static Insets getInsets(String name)
Get a property as an insets. The property must be comma separated numbers (4).


getInt

public static Integer getInt(String name)
Get a property as an integer.


getBoolean

public static Boolean getBoolean(String name)
Get a property as a boolean value.


getDoubles

public static double[] getDoubles(String name)
Get a property as a list of numbers (separated by comma).


Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.