public abstract class ZAction<C extends ApplicationContext> extends javax.swing.AbstractAction implements ApplicationObject<C>, SimpleLogSupport, ErrorHandlerSupport
Action
concept for localized
actions. This class supports three translated presentation strings for an action which are:
BUTTON_TEXT, MENU_TEXT and TIP_TEXT, all of which can be set with the according methods. actionFired(ActionEvent)
for implementing an action (instead of actionPerformed(ActionEvent)
).Constructor and Description |
---|
ZAction(C ctx,
NlsActionKey nlsKey) |
ZAction(C ctx,
NlsActionKey nlsKey,
ActionValidator validator) |
ZAction(C ctx,
NlsActionKey nlsKey,
IconKey iconKey) |
ZAction(C ctx,
NlsActionKey nlsKey,
IconKey iconKey,
ActionValidator validator) |
ZAction(C ctx,
java.lang.String untranslatedName) |
ZAction(NlsActionKey nlsKey) |
ZAction(NlsActionKey nlsKey,
ActionValidator validator) |
ZAction(NlsActionKey nlsKey,
IconKey iconKey) |
ZAction(NlsActionKey nlsKey,
IconKey iconKey,
ActionValidator validator) |
Modifier and Type | Method and Description |
---|---|
protected boolean |
actionConfirmed()
Can be overridden to pop up a ConfirmDialog.
|
protected void |
actionDenied(java.lang.Exception e)
Is called when the action was tried to execute without having permission.
|
protected void |
actionFailed(java.lang.Exception e)
Is called when the action has thrown an Exception.
|
protected abstract void |
actionFired(java.awt.event.ActionEvent e)
Is called when the action is fired.
|
void |
actionPerformed(java.awt.event.ActionEvent e)
Cannot be overridden, subclasses must implement
actionFired(ActionEvent) instead. |
protected void |
actionPrepare()
Runs sync BEFORE the
actionFired(ActionEvent) method is called. |
protected void |
actionSucceeded()
Is called when the action has been executed successfully
|
protected boolean |
checkEnableCondition()
This condition is evaluated automatically after construction.
|
void |
fire()
Convenience method for firing this action
|
C |
getApplicationContext() |
java.lang.String |
getButtonText()
Returns the translated button text.
|
javax.swing.Icon |
getIcon()
Returns icon for this action.
|
LogChannel |
getLogChannel() |
java.lang.String |
getMenuText()
Returns the translated menu text.
|
java.lang.String |
getName()
Returns the unique name (untranslated) of this action.
|
javax.swing.Icon |
getPressedIcon()
Returns icon for the pressed button state.
|
java.lang.String |
getTipText()
Returns the translated tooltip text.
|
boolean |
isForced()
Tells whether the action Confirmation should be suppressed.
|
boolean |
isHandleError() |
boolean |
isLogDebug() |
boolean |
isLogVerbose() |
boolean |
isPermitted()
Returns true if the current validator allows this action
|
void |
logDebug(java.lang.String message) |
void |
logDump(java.lang.String message) |
void |
logError(java.lang.String message) |
void |
logError(java.lang.String message,
java.lang.Exception e) |
void |
logFatal(java.lang.String message,
java.lang.Exception e) |
void |
logInfo(java.lang.String message) |
void |
logVerbose(java.lang.String message) |
void |
logWarning(java.lang.String message) |
void |
performAvailabilityCheck()
Enables/disables the action according to its enable condition.
|
void |
setBusyAnimationEnabled(boolean useBusyAnim)
If set to true then the action shows up with a
BusyAnimationWindow during execution. |
void |
setHandleError(boolean isHandleError) |
void |
setIcon(javax.swing.Icon icon)
Sets an icon for this action.
|
void |
setIcon(IconKey iconKey)
Sets an icon for this action
|
void |
setLogChannel(LogChannel logCh) |
void |
setName(java.lang.String actionName)
Sets the unique name for this action, mainly for debugging purpose.
|
void |
setPressedIcon(javax.swing.Icon icon)
Sets an pressed icon for this action which is shown when a button is pressed.
|
void |
setPressedIcon(IconKey iconKey) |
void |
setText(NlsKey nls)
Sets the text that is used to present this action in a button.
|
void |
setTipText(java.lang.String tipText)
Allows for setting the tip text independent of any NlsKey
|
ZAction |
setValidator(ActionValidator newValidator)
Sets the validator for this action.
|
void |
showError(java.lang.Exception e) |
void |
showError(java.lang.String message,
java.lang.Exception e) |
void |
showError(java.lang.String message,
java.lang.String details,
java.lang.Exception e) |
void |
showInfo(java.lang.String message) |
void |
showInfo(java.lang.String message,
java.lang.String details) |
void |
showWarning(java.lang.String message) |
void |
showWarning(java.lang.String message,
java.lang.String details) |
java.lang.String |
toString()
Returns a string representation of this action - same as getName().
|
public ZAction(NlsActionKey nlsKey, IconKey iconKey)
public ZAction(NlsActionKey nlsKey)
public ZAction(NlsActionKey nlsKey, ActionValidator validator)
public ZAction(NlsActionKey nlsKey, IconKey iconKey, ActionValidator validator)
public ZAction(C ctx, java.lang.String untranslatedName)
public ZAction(C ctx, NlsActionKey nlsKey)
public ZAction(C ctx, NlsActionKey nlsKey, ActionValidator validator)
public ZAction(C ctx, NlsActionKey nlsKey, IconKey iconKey)
public ZAction(C ctx, NlsActionKey nlsKey, IconKey iconKey, ActionValidator validator)
public final C getApplicationContext()
getApplicationContext
in interface ApplicationObject<C extends ApplicationContext>
public final void performAvailabilityCheck()
checkEnableCondition()
public final boolean isHandleError()
public final void setHandleError(boolean isHandleError)
public final void setBusyAnimationEnabled(boolean useBusyAnim)
BusyAnimationWindow
during execution.public final void setIcon(IconKey iconKey)
public final void setIcon(javax.swing.Icon icon)
public final void setPressedIcon(javax.swing.Icon icon)
public final void setPressedIcon(IconKey iconKey)
public final javax.swing.Icon getIcon()
public final javax.swing.Icon getPressedIcon()
public final void setName(java.lang.String actionName)
public final void setText(NlsKey nls)
public final void setTipText(java.lang.String tipText)
public java.lang.String getName()
public final java.lang.String getTipText()
public final java.lang.String getButtonText()
public final java.lang.String getMenuText()
public java.lang.String toString()
toString
in class java.lang.Object
public final void actionPerformed(java.awt.event.ActionEvent e)
actionFired(ActionEvent)
instead.actionPerformed
in interface java.awt.event.ActionListener
public final void fire()
protected void actionPrepare() throws java.lang.Exception
actionFired(ActionEvent)
method is called.
Any preconditional checks or settings may be implemented here.java.lang.Exception
protected boolean actionConfirmed()
protected abstract void actionFired(java.awt.event.ActionEvent e) throws java.lang.Exception
java.lang.Exception
protected void actionFailed(java.lang.Exception e)
protected void actionDenied(java.lang.Exception e)
protected void actionSucceeded()
protected boolean checkEnableCondition()
public final boolean isPermitted()
public final boolean isForced()
public final ZAction setValidator(ActionValidator newValidator)
public final void setLogChannel(LogChannel logCh)
setLogChannel
in interface SimpleLogSupport
public final LogChannel getLogChannel()
getLogChannel
in interface SimpleLogSupport
public final boolean isLogDebug()
isLogDebug
in interface SimpleLogSupport
public final boolean isLogVerbose()
isLogVerbose
in interface SimpleLogSupport
public final void logFatal(java.lang.String message, java.lang.Exception e)
logFatal
in interface SimpleLogSupport
public final void logError(java.lang.String message, java.lang.Exception e)
logError
in interface SimpleLogSupport
public final void logError(java.lang.String message)
logError
in interface SimpleLogSupport
public final void logWarning(java.lang.String message)
logWarning
in interface SimpleLogSupport
public final void logInfo(java.lang.String message)
logInfo
in interface SimpleLogSupport
public final void logVerbose(java.lang.String message)
logVerbose
in interface SimpleLogSupport
public final void logDebug(java.lang.String message)
logDebug
in interface SimpleLogSupport
public final void logDump(java.lang.String message)
logDump
in interface SimpleLogSupport
public final void showError(java.lang.Exception e)
showError
in interface ErrorHandlerSupport
public final void showError(java.lang.String message, java.lang.Exception e)
showError
in interface ErrorHandlerSupport
public final void showError(java.lang.String message, java.lang.String details, java.lang.Exception e)
showError
in interface ErrorHandlerSupport
public final void showInfo(java.lang.String message, java.lang.String details)
showInfo
in interface ErrorHandlerSupport
public final void showInfo(java.lang.String message)
showInfo
in interface ErrorHandlerSupport
public final void showWarning(java.lang.String message, java.lang.String details)
showWarning
in interface ErrorHandlerSupport
public final void showWarning(java.lang.String message)
showWarning
in interface ErrorHandlerSupport
Copyright © 2014 EsprIT-Systems. All Rights Reserved.