Package org.javlo.macro.core

Class MacroBean

java.lang.Object

org.javlo.macro.core.MacroBean

All Implemented Interfaces:

IInteractiveMacro, IMacro

Direct Known Subclasses:

MacroGoHome

public class MacroBean
extends Object
implements IMacro, IInteractiveMacro

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
MacroBean()
MacroBean(String name, String params)
MacroBean(String name, String params, String icon)

Method Summary

Modifier and Type	Method	Description
String	getIcon()
String	getInfo(ContentContext ctx)
String	getModalSize()	return the popup size. default lg
String	getName()
int	getPriority()
String	getRenderer()	get the renderer for interactive macro (return null if macro is'nt interactive)
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)
String	prepare(ContentContext ctx)
void	setAdd(boolean add)
void	setAdmin(boolean admin)
void	setIcon(String icon)
void	setInfo(String info)
void	setInteractive(boolean interactive)
void	setModalSize(String modalSize)
void	setName(String name)
void	setPreview(boolean preview)
void	setUrl(String url)

Methods inherited from class java.lang.Object

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

Constructor Detail

MacroBean

public MacroBean()

MacroBean

public MacroBean(String name,
                 String params)

MacroBean

public MacroBean(String name,
                 String params,
                 String icon)

Method Detail

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:

prepare

public String prepare(ContentContext ctx)

Specified by:

prepare in interface IInteractiveMacro

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"

setModalSize

public void setModalSize(String modalSize)

getName

public String getName()

Specified by:

getName in interface IMacro

setName

public void setName(String name)

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:

setAdmin

public void setAdmin(boolean admin)

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:

setPreview

public void setPreview(boolean preview)

isAdd

public boolean isAdd()

Specified by:

isAdd in interface IMacro

setAdd

public void setAdd(boolean add)

isInterative

public boolean isInterative()

Specified by:

isInterative in interface IMacro

setInteractive

public void setInteractive(boolean interactive)

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

getInfo

public String getInfo(ContentContext ctx)

Specified by:

getInfo in interface IMacro

setInfo

public void setInfo(String info)

getIcon

public String getIcon()

Specified by:

getIcon in interface IMacro

setIcon

public void setIcon(String icon)

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

setUrl

public void setUrl(String url)

getPriority

public int getPriority()

Specified by:

getPriority in interface IMacro