All Known Subinterfaces:

IInteractiveMacro

All Known Implementing Classes:

AbstractDisplayModule, AbstractInteractiveMacro, AbstractMacro, ActiveAllChildren, AddChildMacro, ChangeImageFilter, CleanDuplicatedId, CleanImportFolder, CleanPersistenceFolder, CleanResourceImageMacro, CleanResourceNameMacro, CleanStaticInfoPersistence, ClearContext, ClearDataAccessCount, ClearImageCache, ClearTransformURLCache, CommitTemplate, ComponentsMacroModule, ConvertUserForComansys, CopyCurrentPageToOtherLanguages, CopyLanguageStructureHereMacro, CopyLanguageStructureMacro, CreateAllContentSample, CreateAlphabeticChildrenHereMacro, CreateArticle, CreateArticleComposition, CreateArticleWidthTemplates, CreateBaseStructureMacro, CreateBusinessComponent, CreateChildren, CreateChildrenStructureMacro, CreateContentChildren, CreateDefaultPageStructure, CreateExternalNewsMacro, CreateFakeUsers, CreateMonthHereMacro, CreateMonthStructureMacro, CreatePressReleaseHereMacro, CreatePressReleaseStructure2005Macro, CreatePressReleaseStructure2006HereMacro, CreatePressReleaseStructure2006Macro, CreatePressReleaseStructure2007HereMacro, CreatePressReleaseStructure2007Macro, CreatePressReleaseStructure2008HereMacro, CreatePressReleaseStructure2008Macro, CreatePressReleaseTodayHereMacro, CreatePressReleaseTodayMacro, CreateRedirectionForAllLanguages, CreateRolesFromUserList, CreateWeekHereMacro, CurrentLgExpandMacro, DashOnImageMacro, DefaultLgExpandMacro, DeleteBadTemplate, DeleteChildren, DeleteChildrenAndContent, DeleteChildrenContent, DeleteComponent, DeleteComponentBadArea, DeleteComponentWithBadResourceReference, DeleteContentFiles, DeleteDynamicComponent, DeletePageFromSpecificUser, DeleteSameComponent, DeleteSmartExternalLinkMacro, DeleteTestPage, DeleteTrackerCache, DetectAllComponentsType, DisplayDashBoard, DisplaySeoReport, DownDateMacro, DuplicateChildren, DuplicatePage, DuplicatePageIndexed, EncryptPasswordComponent, EncryptVisitorsPasswordMacro, FileInListMacro, ImageAfterDescriptionChildrenMacro, ImageAfterDescriptionMacro, ImportAndTranslateDefaultLanguageMacro, ImportContent, ImportDataBase, ImportDefaultLanguageMacro, ImportExternalPage, ImportGalleryMacro, ImportHTMLPageMacro, ImportJCRPageMacro, IncreaseSubtitleLevelMacro, InitContentMacro, JekaConvert, LogAsUser, MacroBean, MacroGoHome, MacroRendererCorrection, MailingMacroModule, MailingStat, MergeDynamicComponent, MergeGalleryAndGalleries, MergeImagesInGallery, NoClickableImageMacro, NoDashOnImageMacro, PasteCopiedElementInAllLanguageMacro, PublishMacro, PushStaticOnFtp, RebuitTemplate, RebuitTemplateHtml, ReduceSubtitleLevelMacro, RenameChildren, ResetRecaptcha, SmartImport, SocialShare, SortChildren, StaticInfoAutoFill, TaxonomyMacroModule, TemplateMacroModule, TransfertComponentBadAreaToContent, UndeletePage, UnlinkMirrorComponent, UpDateMacro, UpdateTemplate, UpdateUserRole, UploadGallery, UserMacroModule, ValidAllChildren
```
public interface IMacro
```

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`DEFAULT_MAX_MODAL_SIZE`
`static int`	`DEFAULT_PRIORITY`
`static String`	`LARGE_MODAL_SIZE`
`static String`	`MIDDEL_MODAL_SIZE`
`static String`	`SMALL_MODAL_SIZE`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getIcon()`
`String`	`getInfo(ContentContext ctx)`
`String`	`getName()`
`int`	`getPriority()`
`String`	`getUrl()`	force url of the macro
`void`	`init(ContentContext ctx)`
`boolean`	`isActive()`	is macro active in current context
`boolean`	`isAdd()`
`boolean`	`isAdmin()`	macro for admin >> return true macro for contributor >> retrun false
`boolean`	`isInterative()`
`boolean`	`isPreview()`	is this macro can be execute in preview mode.
`String`	`perform(ContentContext ctx, Map<String,Object> params)`

- Field Detail
  - DEFAULT_MAX_MODAL_SIZE
```
static final String DEFAULT_MAX_MODAL_SIZE
```
    See Also:
    
    Constant Field Values
  - LARGE_MODAL_SIZE
```
static final String LARGE_MODAL_SIZE
```
    See Also:
    
    Constant Field Values
  - MIDDEL_MODAL_SIZE
```
static final String MIDDEL_MODAL_SIZE
```
    See Also:
    
    Constant Field Values
  - SMALL_MODAL_SIZE
```
static final String SMALL_MODAL_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PRIORITY
```
static final int DEFAULT_PRIORITY
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getName
```
String getName()
```
  - perform
```
String perform(ContentContext ctx,
               Map<String,Object> params)
        throws Exception
```
    Throws:
    
    Exception
  - isAdmin
```
boolean isAdmin()
```
    macro for admin >> return true macro for contributor >> retrun false
    
    Returns:
  - isPreview
```
boolean isPreview()
```
    is this macro can be execute in preview mode.
    
    Returns:
  - isAdd
```
boolean isAdd()
```
  - isInterative
```
boolean isInterative()
```
  - isActive
```
boolean isActive()
```
    is macro active in current context
    
    Returns:
  - init
```
void init(ContentContext ctx)
```
  - getInfo
```
String getInfo(ContentContext ctx)
```
  - getIcon
```
String getIcon()
```
  - getUrl
```
String getUrl()
```
    force url of the macro
    
    Returns:
    
    default null >> url will be generated for default macro modal
  - getPriority
```
int getPriority()
```

Interface IMacro

Field Summary

Method Summary

Field Detail

DEFAULT_MAX_MODAL_SIZE

LARGE_MODAL_SIZE

MIDDEL_MODAL_SIZE

SMALL_MODAL_SIZE

DEFAULT_PRIORITY

Method Detail

getName

perform

isAdmin

isPreview

isAdd

isInterative

isActive

init

getInfo

getIcon

getUrl

getPriority