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.model.api
Class FormatValueHandle

    java.lang.Object
      org.eclipse.birt.report.model.api.ElementDetailHandle
          org.eclipse.birt.report.model.api.ValueHandle
              org.eclipse.birt.report.model.api.StructureHandle
                  org.eclipse.birt.report.model.api.FormatValueHandle

    public class FormatValueHandle

extends StructureHandle

Represents a format value in the style or the highlight rule.

Field Summary

Fields inherited from class org.eclipse.birt.report.model.api.StructureHandle
`structRef`

Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
`elementHandle`

Constructor Summary
`FormatValueHandle(DesignElementHandle element, org.eclipse.birt.report.model.core.MemberRef ref)` Construct an handle to deal with the action structure.
`FormatValueHandle(SimpleValueHandle valueHandle, int index)` Constructs the handle of configuration variable.

Method Summary
`java.lang.String` | `getCategory()` Returns the category of the format.
`java.lang.String` | `getPattern()` Returns the pattern of the format.
`void` | `setCategory(java.lang.String pattern)` Sets the category of the format.
`void` | `setPattern(java.lang.String value)` Sets the pattern of the format.

Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle
`drop, getDefn, getExternalizedValue, getMember, getProperty, getPropertyDefn, getReference, getStringProperty, getStructure, isDesignTime, iterator, setDesignTime, setProperty, setPropertySilently`

Methods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
`getDesign, getElement, getElementHandle, getModule`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### FormatValueHandle

    public FormatValueHandle(DesignElementHandle element,
                             org.eclipse.birt.report.model.core.MemberRef ref)

  Construct an handle to deal with the action structure.

  Parameters:
    `element` - the element that defined the action.
    `ref` - reference to the action property.

### FormatValueHandle

    public FormatValueHandle(SimpleValueHandle valueHandle,
                             int index)

  Constructs the handle of configuration variable.

  Parameters:
    `valueHandle` - the value handle for configuration variable list of one property
    `index` - the position of this configuration variable in the list

Method Detail

### getCategory

    public java.lang.String getCategory()

  Returns the category of the format.

  Returns:
    the category of the format

### setCategory

    public void setCategory(java.lang.String pattern)
                     throws SemanticException

  Sets the category of the format.

  Parameters:
    `pattern` - the category of the format
  Throws:
    `SemanticException` - if `pattern` is not one of the BIRT defined.

### getPattern

    public java.lang.String getPattern()

  Returns the pattern of the format.

  Returns:
    the pattern of the format

### setPattern

    public void setPattern(java.lang.String value)

  Sets the pattern of the format.

  Parameters:
    `value` - the pattern of the format

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.