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.elements.structures
Class TimeFormatValue

    java.lang.Object
      org.eclipse.birt.report.model.core.Structure
          org.eclipse.birt.report.model.api.elements.structures.FormatValue
              org.eclipse.birt.report.model.api.elements.structures.TimeFormatValue

All Implemented Interfaces:
  java.lang.Cloneable, IStructure, org.eclipse.birt.report.model.core.IPropertySet

    public class TimeFormatValue

extends FormatValue

The format value for the time.

Field Summary
`static java.lang.String` | `FORMAT_VALUE_STRUCT` Name of this structure.

Fields inherited from class org.eclipse.birt.report.model.api.elements.structures.FormatValue
`CATEGORY_MEMBER, LOCALE_MEMBER, PATTERN_MEMBER`

Constructor Summary
`TimeFormatValue()`

Method Summary
`StructureHandle` | `getHandle(SimpleValueHandle valueHandle)` Return an `FormatValueHandle` to deal with the date-time format.
`java.lang.String` | `getStructName()` Returns the name of the structure definition.
`StructureHandle` | `handle(SimpleValueHandle valueHandle, int index)`

Methods inherited from class org.eclipse.birt.report.model.api.elements.structures.FormatValue
`getCategory, getIntrinsicProperty, getLocale, getPattern, setCategory, setIntrinsicProperty, setLocale, setPattern, toString`

Methods inherited from class org.eclipse.birt.report.model.core.Structure
`checkStringMember, copy, equals, getCompatibleValue, getContext, getDefn, getElement, getExpressionProperty, getHandle, getLocalProperty, getLocalProperty, getMemberDefn, getObjectDefn, getProperty, getProperty, getReferencableProperty, getStringProperty, isDesignTime, isReferencable, setContext, setExpressionProperty, setProperty, setProperty, setupContext, updateReference, validate`

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

Field Detail

### FORMAT_VALUE_STRUCT

    public static final java.lang.String FORMAT_VALUE_STRUCT

  Name of this structure. Matches the definition in the meta-data dictionary.

  See Also:
    Constant Field Values

Constructor Detail

### TimeFormatValue

    public TimeFormatValue()

Method Detail

### getStructName

    public java.lang.String getStructName()

  Description copied from interface: `IStructure`
  Returns the name of the structure definition. The name is the one used to define the structure in the meta-data dictionary.

  Specified by:
    `getStructName` in interface `IStructure`
  Overrides:
    `getStructName` in class `FormatValue`
  Returns:
    the internal name of the structure a defined in the meta-data dictionary.

### handle

    public StructureHandle handle(SimpleValueHandle valueHandle,
                                  int index)

  Overrides:
    `handle` in class `FormatValue`

### getHandle

    public StructureHandle getHandle(SimpleValueHandle valueHandle)

  Return an `FormatValueHandle` to deal with the date-time format.

  Overrides:
    `getHandle` in class `FormatValue`
  Parameters:
    `valueHandle` - the property or member handle
  Returns:
    the structure handle

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.