org.eclnt.jsfserver.elements.macros

## Interface IMacro

- All Known Implementing Classes:
    XMLMacro

      public interface IMacro

  A Macro can automatically create tag attribute names out of information that is already defined within the grid.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `checkIfApplicable(java.lang.String tagName)` Check if a macro can be executed for a certain tag.
    `boolean` | `checkIfAttributeIsAffected(java.lang.String attribute)` Check if macro updates a certain attribute's value.
    `void` | `executeMacro(BaseComponentTag tag, java.lang.String[] macroParams)` Macro execution at runtime.
    `java.lang.String[]` | `getMacroParamNames()` Names of Macro parameters.
    `java.lang.String` | `getName()` Name of the macro.

- - ### Method Detail

    - #### executeMacro

          void executeMacro(BaseComponentTag tag,
                            java.lang.String[] macroParams)

      Macro execution at runtime.

    - #### checkIfApplicable

          boolean checkIfApplicable(java.lang.String tagName)

      Check if a macro can be executed for a certain tag. This function is e.g. called in the Layout Editor: the select box of available macros is filled correspondingly.

    - #### checkIfAttributeIsAffected

          boolean checkIfAttributeIsAffected(java.lang.String attribute)

      Check if macro updates a certain attribute's value. This function is called e.g. by the Layout Editor: all attributes that are maintained by the macro are marked correspondingly.

    - #### getName

          java.lang.String getName()

      Name of the macro.

    - #### getMacroParamNames

          java.lang.String[] getMacroParamNames()

      Names of Macro parameters. Null may be returned in case the macro does not provide for any parameters.

Copyright © CaptainCasa Gmbh. All Rights Reserved.