Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.eclipse.birt.report.engine.api.script.element
Interface IHighlightRule

    public interface IHighlightRule

Represents the design of an HighLightRule in the scripting environment

Method Summary
`java.lang.String` | `getBackGroundColor()` Returns backgroudcolor
`java.lang.String` | `getColor()` Returns color
`java.lang.String` | `getDateTimeFormat()` Return date time format.
`java.lang.String` | `getFontStyle()` Returns font style
`java.lang.String` | `getFontWeight()` Returns font weight.
`java.lang.String` | `getOperator()` Returns Operator
`java.lang.String` | `getStringFormat()` Returns string format
`IStructure` | `getStructure()` Returns structure.
`java.lang.String` | `getTestExpression()` Returns Test Expression
`java.lang.String` | `getValue1()` Returns value1
`java.lang.String` | `getValue2()` Returns value2
`void` | `setBackGroundColor(java.lang.String color)` Sets backgroudcolor
`void` | `setColor(java.lang.String color)` Sets color
`void` | `setDateTimeFormat(java.lang.String format)` Sets date time format
`void` | `setFontStyle(java.lang.String style)` Sets font style
`void` | `setFontWeight(java.lang.String weight)` Sets font weight.
`void` | `setOperator(java.lang.String operator)` Sets Operator
`void` | `setStringFormat(java.lang.String format)` Sets string format
`void` | `setTestExpression(java.lang.String expression)` Sets Test Expression
`void` | `setValue1(java.lang.String value1)` Sets Value1
`void` | `setValue2(java.lang.String value2)` Sets Value2

Method Detail

### getTestExpression

    java.lang.String getTestExpression()

  Returns Test Expression

  Returns:
    Test Expression

### setTestExpression

    void setTestExpression(java.lang.String expression)
                           throws ScriptException

  Sets Test Expression

  Parameters:
    `expression` -
  Throws:
    `ScriptException`

### getFontStyle

    java.lang.String getFontStyle()

  Returns font style

  Returns:
    font style

### setFontStyle

    void setFontStyle(java.lang.String style)
                      throws ScriptException

  Sets font style

  Parameters:
    `style` -
  Throws:
    `ScriptException`

### getFontWeight

    java.lang.String getFontWeight()

  Returns font weight.

  Returns:
    font weight.

### setFontWeight

    void setFontWeight(java.lang.String weight)
                       throws ScriptException

  Sets font weight.

  Parameters:
    `weight` -
  Throws:
    `ScriptException`

### getDateTimeFormat

    java.lang.String getDateTimeFormat()

  Return date time format.

  Returns:
    date time format.

### setDateTimeFormat

    void setDateTimeFormat(java.lang.String format)
                           throws ScriptException

  Sets date time format

  Parameters:
    `format` -
  Throws:
    `ScriptException`

### getStringFormat

    java.lang.String getStringFormat()

  Returns string format

  Returns:
    string format

### setStringFormat

    void setStringFormat(java.lang.String format)
                         throws ScriptException

  Sets string format

  Parameters:
    `format` -
  Throws:
    `ScriptException`

### getColor

    java.lang.String getColor()

  Returns color

  Returns:
    color

### getValue1

    java.lang.String getValue1()

  Returns value1

  Returns:
    value1

### getValue2

    java.lang.String getValue2()

  Returns value2

  Returns:
    value2

### getOperator

    java.lang.String getOperator()

  Returns Operator

  Returns:
    operator

### getBackGroundColor

    java.lang.String getBackGroundColor()
                                        throws ScriptException

  Returns backgroudcolor

  Returns:
    backgroudcolor
  Throws:
    `ScriptException`

### setColor

    void setColor(java.lang.String color)
                  throws ScriptException

  Sets color

  Parameters:
    `color` -
  Throws:
    `ScriptException`

### setValue1

    void setValue1(java.lang.String value1)
                   throws ScriptException

  Sets Value1

  Parameters:
    `value1` -
  Throws:
    `ScriptException`

### setValue2

    void setValue2(java.lang.String value2)
                   throws ScriptException

  Sets Value2

  Parameters:
    `value2` -
  Throws:
    `ScriptException`

### setOperator

    void setOperator(java.lang.String operator)
                     throws ScriptException

  Sets Operator

  Parameters:
    `operator` -
  Throws:
    `ScriptException`

### setBackGroundColor

    void setBackGroundColor(java.lang.String color)
                            throws ScriptException

  Sets backgroudcolor

  Parameters:
    `color` -
  Throws:
    `ScriptException`

### getStructure

    IStructure getStructure()

  Returns structure.

  Returns:
    structure

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008 Actuate Corp. All rights reserved.