public class Action
extends java.lang.Object
implements java.io.Serializable
Custom action
Modifier and Type | Field and Description |
---|---|
static char |
ACTION_ALL
Display both on list header, form and lines of list
|
static char |
ACTION_FORM
Enable on form / display on form and lines of list
|
static char |
ACTION_FORM_ONLY
Enable on form / display on form only, not on list items
|
static char |
ACTION_HIDDEN
Hidden on UI (but may be enabled for a cron job)
|
static char |
ACTION_LIST
Enable on list / display in list header
|
static char |
ACTION_LIST_FORM
Both form and List header (but not on list items)
|
static char |
ACTION_LIST_ITEMS_ONLY
Enable on form / display on list items only, not on form
|
static int |
ASYNC_NONE
Synchronous call (means that the job will be launched directly after instantiation)
|
static int |
ASYNC_SESSION
New thread in the current Grant session with the current instance of Object
|
static int |
ASYNC_STANDALONE
New Grant session with the job instance of Object
|
Constructor and Description |
---|
Action(Action action,
int position)
Copy constructor
|
Action(java.lang.String name,
char type,
java.util.Hashtable<java.lang.String,java.lang.String> display,
java.lang.String image,
int position,
boolean plus)
Silent constructor (no method, no URL).
|
Action(java.lang.String id,
java.lang.String name,
char type,
java.util.Hashtable<java.lang.String,java.lang.String> display,
java.util.Hashtable<java.lang.String,java.lang.String> help,
java.lang.String method,
java.lang.String expr,
java.lang.String url,
java.lang.String image,
boolean confirm,
boolean plus,
int async,
int asyncDepth)
Constructor
|
Modifier and Type | Method and Description |
---|---|
void |
disable()
Deactivate the action
|
void |
enable()
Activate the action
|
java.lang.String |
extractTarget() |
java.lang.String |
extractURL(ObjectCore obj,
java.lang.String contextParams) |
java.lang.String |
getAnchor(ObjectCore obj,
java.lang.String contextParams) |
java.lang.String |
getAnchor(ObjectCore obj,
java.lang.String contextParams,
java.lang.String extraParams) |
int |
getAsync() |
int |
getAsyncDepth() |
int |
getDefaultPosition()
Get default position
|
char |
getDefaultType()
Get action default type
|
java.util.Hashtable<java.lang.String,java.lang.String> |
getDisplay() |
java.lang.String |
getDisplay(java.lang.String lang) |
java.lang.String |
getExpression() |
java.util.Hashtable<java.lang.String,java.lang.String> |
getHelp() |
java.lang.String |
getHelp(java.lang.String lang) |
java.lang.String |
getId() |
java.lang.String |
getImage()
Get the icon name
|
java.lang.String |
getMethod() |
java.lang.String |
getName() |
char |
getType()
Get action current type
|
java.lang.String |
getURL() |
boolean |
isConfirm()
Action needs a user confirmation ?
|
boolean |
isCustom()
Is custom or standard action ?
|
boolean |
isDefaultPlus()
By default in Plus button ?
|
boolean |
isEnabled()
Is the action available
|
boolean |
isFormVisible() |
boolean |
isLimitedbyCount()
History of job is limited by count ?
|
boolean |
isLimitedByDays()
History of job is limited by days ?
|
boolean |
isListItemVisible() |
boolean |
isListVisible() |
boolean |
isPlus()
Action can be displayed in Plus button ?
|
boolean |
isUnlimited()
Unlimited jobs history ?
|
void |
setAsync(int async) |
void |
setAsyncDepth(int depth) |
void |
setConfirm(boolean b) |
void |
setDefaultPosition(int pos)
Set default position
|
void |
setDisplay(java.lang.String lang,
java.lang.String disp) |
void |
setEnabled(boolean b)
Enable the action or not
|
void |
setExpression(java.lang.String expr) |
void |
setHelp(java.lang.String lang,
java.lang.String help) |
void |
setImage(java.lang.String name)
Set the icon name
|
void |
setMethod(java.lang.String method) |
void |
setName(java.lang.String name) |
void |
setPlus(boolean plus)
Set the display in Plus button
|
void |
setType(char type)
change action current type
|
void |
setURL(java.lang.String url) |
boolean |
showLabel()
Show label on button ?
|
void |
showLabel(boolean show)
Show label on button ?
|
java.lang.String |
toString()
Generates basic string dump for action (usefull for debug purposes)
|
public static final char ACTION_LIST
public static final char ACTION_FORM
public static final char ACTION_ALL
public static final char ACTION_LIST_FORM
public static final char ACTION_FORM_ONLY
public static final char ACTION_LIST_ITEMS_ONLY
public static final char ACTION_HIDDEN
public static final int ASYNC_NONE
public static final int ASYNC_SESSION
public static final int ASYNC_STANDALONE
public Action(java.lang.String id, java.lang.String name, char type, java.util.Hashtable<java.lang.String,java.lang.String> display, java.util.Hashtable<java.lang.String,java.lang.String> help, java.lang.String method, java.lang.String expr, java.lang.String url, java.lang.String image, boolean confirm, boolean plus, int async, int asyncDepth)
name
- Action nametype
- Visibilitydisplay
- Translation per languagehelp
- Help per languagemethod
- Action methodexpr
- Action expressionurl
- Action URLimage
- Iconconfirm
- Confirm action ?plus
- Display in Plus button when possible ?async
- Asynchronous mode CronJob.ASYNC_*asyncDepth
- Execution jobs depth (null not limited)public Action(java.lang.String name, char type, java.util.Hashtable<java.lang.String,java.lang.String> display, java.lang.String image, int position, boolean plus)
public Action(Action action, int position)
public java.lang.String getId()
public java.lang.String getName()
public void setName(java.lang.String name)
public void setType(char type)
public char getType()
public char getDefaultType()
public java.lang.String getDisplay(java.lang.String lang)
public void setDisplay(java.lang.String lang, java.lang.String disp)
public java.util.Hashtable<java.lang.String,java.lang.String> getDisplay()
public java.lang.String getHelp(java.lang.String lang)
public void setHelp(java.lang.String lang, java.lang.String help)
public java.util.Hashtable<java.lang.String,java.lang.String> getHelp()
public java.lang.String getMethod()
public void setMethod(java.lang.String method)
public java.lang.String getExpression()
public void setExpression(java.lang.String expr)
public void setURL(java.lang.String url)
public java.lang.String getURL()
public int getAsync()
public void setAsync(int async)
public int getAsyncDepth()
public void setAsyncDepth(int depth)
public boolean isLimitedByDays()
public boolean isLimitedbyCount()
public boolean isUnlimited()
public java.lang.String extractURL(ObjectCore obj, java.lang.String contextParams)
public java.lang.String extractTarget()
public java.lang.String getAnchor(ObjectCore obj, java.lang.String contextParams)
public java.lang.String getAnchor(ObjectCore obj, java.lang.String contextParams, java.lang.String extraParams)
public java.lang.String getImage()
public void setImage(java.lang.String name)
public boolean isConfirm()
public void setConfirm(boolean b)
public boolean isPlus()
public void setPlus(boolean plus)
public boolean isDefaultPlus()
public int getDefaultPosition()
public void setDefaultPosition(int pos)
public boolean showLabel()
public void showLabel(boolean show)
public boolean isCustom()
public void enable()
public void disable()
public boolean isEnabled()
public void setEnabled(boolean b)
public boolean isFormVisible()
public boolean isListVisible()
public boolean isListItemVisible()
public java.lang.String toString()
Generates basic string dump for action (usefull for debug purposes)
toString
in class java.lang.Object
Copyright (c)2006-2014 Simplicite Software. All Rights Reserved.