Class AbstractThemeHandle

All Implemented Interfaces:
org.eclipse.birt.report.model.elements.interfaces.IAbstractThemeModel, org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel
Direct Known Subclasses:
ReportItemThemeHandle, ThemeHandle

public abstract class AbstractThemeHandle extends ReportElementHandle implements org.eclipse.birt.report.model.elements.interfaces.IAbstractThemeModel
Represents a abstract theme in the library. Each theme contains some number of styles. It can be a normal theme or a report item theme.
See Also:
  • Theme
  • Constructor Details

    • AbstractThemeHandle

      public AbstractThemeHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
      Constructs the handle for a theme with the given design and element. The application generally does not create handles directly. Instead, it uses one of the navigation methods available on other element handles.
      Parameters:
      module - the module
      element - the model representation of the element
  • Method Details

    • getStyles

      public final SlotHandle getStyles()
      Returns the styles slot of row. Through SlotHandle, each style can be obtained.
      Returns:
      the handle to the style slot
      See Also:
    • getAllStyles

      public final List<DesignElementHandle> getAllStyles()
      Gets all styles in theme,include css file.
      Returns:
      all styles.each item is StyleHandle
    • findStyle

      public final StyleHandle findStyle(String name)
      Returns the style with the given name.
      Parameters:
      name - the style name
      Returns:
      the corresponding style
    • getDisplayLabel

      public final String getDisplayLabel(int level)
      Description copied from class: DesignElementHandle
      Returns the display label for this element. The display label is the localized display name to be shown in the UI. The display label is one of the following:

      • The localized display name of this element, if the display name resource key is set and the localized string is available
      • The static display name property text of this element, if set
      • The name of element, if set
      • The localized display name of this kind of element, which is defined in metadata, if set
      • The name of this kind of element, which is also defined in metadata

      The user can also decide at which detail level the display label should be returned. The level can be one of the following options:

      • USER_LABEL: Only the first 3 steps are used, if not found, return null
      • SHORT_LABEL: All the above steps are used. This will ensure there will be a return value
      • FULL_LABEL: Besides the return value of SHORT_LABEL, this option says we need to return additional information. This information is specific to each kind of element and my include row and column position, x and y position and so on. To get this, every child element needs to overwrite this method
      Overrides:
      getDisplayLabel in class DesignElementHandle
      Parameters:
      level - the display label detail level
      Returns:
      the display label of this element in a given level
    • includeCssesIterator

      public final Iterator includeCssesIterator()
      Returns the iterator over all included css style sheets. Each one is the instance of IncludedCssStyleSheetHandle
      Returns:
      the iterator over all included css style sheets.
    • getAllCssStyleSheets

      public List<CssStyleSheetHandle> getAllCssStyleSheets()
      Gets all css styles sheet
      Returns:
      each item is CssStyleSheetHandle
    • addCss

      public void addCss(CssStyleSheetHandle sheetHandle) throws SemanticException
      (non-Javadoc)
      Parameters:
      sheetHandle -
      Throws:
      SemanticException
      See Also:
    • addCss

      public void addCss(IncludedCssStyleSheet cssStruct) throws SemanticException
      (non-Javadoc)
      Parameters:
      cssStruct -
      Throws:
      SemanticException
      See Also:
    • addCss

      @Deprecated public void addCss(String fileName) throws SemanticException
      Deprecated.
      Add css based on file
      Parameters:
      fileName - file name of the css style sheet
      Throws:
      SemanticException
    • addCssByProerties

      public void addCssByProerties(String fileName, String externalCssURI, boolean isUseExternalCss) throws SemanticException
      Add css based on properties
      Parameters:
      fileName - file name of the css file
      externalCssURI - external css uri
      isUseExternalCss - use external css
      Throws:
      SemanticException
    • dropCss

      public void dropCss(CssStyleSheetHandle sheetHandle) throws SemanticException
      Check if the css style sheet can be dropped based on sheet handle
      Parameters:
      sheetHandle -
      Throws:
      SemanticException
    • canDropCssStyleSheet

      public boolean canDropCssStyleSheet(CssStyleSheetHandle sheetHandle)
      Check if the css style sheet can be dropped based on sheet handle
      Parameters:
      sheetHandle - sheet handle to be validated
      Returns:
      Return the value of drop option of css style sheet
    • canAddCssStyleSheet

      public boolean canAddCssStyleSheet(CssStyleSheetHandle sheetHandle)
      Check if the css style sheet can be added based on sheet handle
      Parameters:
      sheetHandle - sheet handle to be validated
      Returns:
      Return the validation result of the add option
    • canAddCssStyleSheet

      @Deprecated public boolean canAddCssStyleSheet(String fileName)
      Deprecated.
      Check if the css style sheet can be added based on file name
      Parameters:
      fileName - file name of the css style sheet
      Returns:
      Return the validation result of the add option
    • canAddCssStyleSheetByProperties

      public boolean canAddCssStyleSheetByProperties(String fileName, String externalCssURI, boolean useExternalCss)
      Check if the css style sheet can be added based on properties
      Parameters:
      fileName - file name of the css file
      externalCssURI - external css uri
      useExternalCss - use external css
      Returns:
      Give the value of add option of css sytle sheet
    • reloadCss

      public void reloadCss(CssStyleSheetHandle sheetHandle) throws SemanticException
      Reload the css style
      Parameters:
      sheetHandle - css style sheet handle to be reloaded
      Throws:
      SemanticException
    • findCssStyleSheetHandleByName

      @Deprecated public CssStyleSheetHandle findCssStyleSheetHandleByName(String fileName)
      Deprecated.
      Find the css style sheet handle based on file name
      Parameters:
      fileName - file name of the css style sheet
      Returns:
      Return the css style sheet handle
    • findCssStyleSheetHandleByProperties

      public CssStyleSheetHandle findCssStyleSheetHandleByProperties(String fileName, String externalCssURI, boolean useExternalCss)
      Find the css style sheet handle based on properties
      Parameters:
      fileName - file name of the css
      externalCssURI - external css uri
      useExternalCss - use external css
      Returns:
      Return the css style sheet handle
    • findIncludedCssStyleSheetHandleByName

      @Deprecated public IncludedCssStyleSheetHandle findIncludedCssStyleSheetHandleByName(String fileName)
      Deprecated.
      Find the included css style sheet handle based on file name
      Parameters:
      fileName - file name of the css
      Returns:
      Return the css style sheet handle
    • findIncludedCssStyleSheetHandleByProperties

      public IncludedCssStyleSheetHandle findIncludedCssStyleSheetHandleByProperties(String fileName, String externalCssURI, boolean useExternalCss)
      Find the included css style sheet handle based on properties
      Parameters:
      fileName - file name of the css
      externalCssURI - external css uri
      useExternalCss - use external css
      Returns:
      Return the css style sheet handle
    • renameCss

      @Deprecated public void renameCss(IncludedCssStyleSheetHandle handle, String newFileName) throws SemanticException
      Deprecated.
      Rename css properties based on file name
      Parameters:
      handle - css sytle sheet handle
      newFileName - new file name
      Throws:
      SemanticException
    • renameCssByProperties

      public void renameCssByProperties(IncludedCssStyleSheetHandle handle, String newFileName, String externalCssURI, boolean useExternalCss) throws SemanticException
      Rename css properties based on properties
      Parameters:
      handle - css style sheet handle
      newFileName - new file name
      externalCssURI - external css uri
      useExternalCss - use external css
      Throws:
      SemanticException
    • canRenameCss

      @Deprecated public boolean canRenameCss(IncludedCssStyleSheetHandle handle, String newFileName) throws SemanticException
      Deprecated.
      Verify if the css could be renamed by file name
      Parameters:
      handle - css style sheet handle
      newFileName - new file name
      Returns:
      Verification result of renaming
      Throws:
      SemanticException
    • canRenameCssByProperties

      public boolean canRenameCssByProperties(IncludedCssStyleSheetHandle handle, String newFileName, String externalCssURI, boolean useExternalCss) throws SemanticException
      Verify if the css could be renamed by property
      Parameters:
      handle - css style sheet handle
      newFileName - new file name
      externalCssURI - external css uri
      useExternalCss - use external css
      Returns:
      Verification result of renaming
      Throws:
      SemanticException