Package org.javlo.macro.interactive

Class AbstractDisplayModule

java.lang.Object

org.javlo.macro.interactive.AbstractDisplayModule

All Implemented Interfaces:

IAction, IInteractiveMacro, IMacro

Direct Known Subclasses:

ComponentsMacroModule, MailingMacroModule, TaxonomyMacroModule, TemplateMacroModule, UserMacroModule

public abstract class AbstractDisplayModule
extends Object
implements IInteractiveMacro, IAction

Field Summary

Fields inherited from interface org.javlo.macro.core.IMacro

DEFAULT_MAX_MODAL_SIZE, DEFAULT_PRIORITY, LARGE_MODAL_SIZE, MIDDEL_MODAL_SIZE, SMALL_MODAL_SIZE

Constructor Summary

Constructors

Constructor	Description
AbstractDisplayModule()

Method Summary

Modifier and Type	Method	Description
String	getActionGroupName()	the group name of the action
String	getIcon()
String	getInfo(ContentContext ctx)
String	getModalSize()	return the popup size. default lg
protected abstract IModuleAction	getModuleAction(ContentContext ctx)
abstract String	getName()
String	getParams(ContentContext ctx)
int	getPriority()
String	getRenderer()	get the renderer for interactive macro (return null if macro is'nt interactive)
String	getUrl()	force url of the macro
boolean	haveRight(ContentContext ctx, String action)
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)
String	prepare(ContentContext ctx)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractDisplayModule

public AbstractDisplayModule()

Method Detail

getName

public abstract String getName()

Specified by:

getName in interface IMacro

getModuleAction

protected abstract IModuleAction getModuleAction(ContentContext ctx)

prepare

public String prepare(ContentContext ctx)

Specified by:

prepare in interface IInteractiveMacro

getParams

public String getParams(ContentContext ctx)

perform

public String perform(ContentContext ctx,
                      Map<String,Object> params)
               throws Exception

Specified by:

perform in interface IMacro

Throws:

Exception

isAdmin

public boolean isAdmin()

Description copied from interface: IMacro

macro for admin >> return true macro for contributor >> retrun false

Specified by:

isAdmin in interface IMacro

Returns:

getRenderer

public String getRenderer()

Description copied from interface: IInteractiveMacro

get the renderer for interactive macro (return null if macro is'nt interactive)

Specified by:

getRenderer in interface IInteractiveMacro

Returns:

getActionGroupName

public String getActionGroupName()

Description copied from interface: IAction

the group name of the action

Specified by:

getActionGroupName in interface IAction

Returns:

a group name.

getInfo

public String getInfo(ContentContext ctx)

Specified by:

getInfo in interface IMacro

isPreview

public boolean isPreview()

Description copied from interface: IMacro

is this macro can be execute in preview mode.

Specified by:

isPreview in interface IMacro

Returns:

isAdd

public boolean isAdd()

Specified by:

isAdd in interface IMacro

isInterative

public boolean isInterative()

Specified by:

isInterative in interface IMacro

haveRight

public boolean haveRight(ContentContext ctx,
                         String action)

Specified by:

haveRight in interface IAction

isActive

public boolean isActive()

Description copied from interface: IMacro

is macro active in current context

Specified by:

isActive in interface IMacro

Returns:

init

public void init(ContentContext ctx)

Specified by:

init in interface IMacro

getModalSize

public String getModalSize()

Description copied from interface: IInteractiveMacro

return the popup size. default lg

Specified by:

getModalSize in interface IInteractiveMacro

Returns:

"lg", "md", "sm", "xs"

getIcon

public String getIcon()

Specified by:

getIcon in interface IMacro

getUrl

public String getUrl()

Description copied from interface: IMacro

force url of the macro

Specified by:

getUrl in interface IMacro

Returns:

default null >> url will be generated for default macro modal

getPriority

public int getPriority()

Specified by:

getPriority in interface IMacro