Class Statusbar
java.lang.Object
org.eclnt.jsfserver.defaultscreens.Statusbar
- All Implemented Interfaces:
Serializable
Default status bar output. The public static methods are the
ones to be used inside using programs. The status bar relates
to the ROWSTATUSBAR component and provides the default
properties.
If using exactly one status bar within your application, then it is sufficient to just use the static methods in order to address the central status bar.
If using more than one status bar (e.g. when separating the application into different frames) then you need to use the object-related methods (i.e. the non-static methods).
If using exactly one status bar within your application, then it is sufficient to just use the static methods in order to address the central status bar.
If using more than one status bar (e.g. when separating the application into different frames) then you need to use the object-related methods (i.e. the non-static methods).
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionclass
static interface
static class
Default implementation ofStatusbar.IStatusBarDrillDownInfoProvider
- not passing any messages to the global status bar.static class
static class
-
Field Summary
Modifier and TypeFieldDescriptionstatic String
static String
static String
static String
static String
static boolean
Definition if status bar popups are opened with some animation.static int
Opacity of statusbar popups.static boolean
Definition if status bar popups are opened undecorated or not.static String
static String
static String
static String
static String
static String
static String
static String
static final int
static final int
static final int
static final int
static final int
-
Constructor Summary
ConstructorDescriptionStatusbar
(Statusbar.IStatusBarDrillDownInfoProvider statusBarDrillDownInfoProvider) -
Method Summary
Modifier and TypeMethodDescriptionstatic void
autoClearStatusbar
(int duration) Advise status bar to clear its content a certain duration (in milliseconds).void
autoClearStatusbarContent
(int duration) Advise status bar to clear its content a certain duration (in milliseconds).static void
By default the statusbar is cleared with each roundtrip.int
checkIfMessageAlreadyWasOutput
(int messageType, String messageText) Checks if a message already was output to the status bar.int
checkIfMessageAlreadyWasOutput
(String messageText) Checks if a message already was output to the status bar.void
clear()
Clear statusbar output.void
destroy()
int
int
getFont()
getImage()
static boolean
boolean
Messages that are currently shown in the status bar.boolean
Message that is sent to the client side and that contains application information that is read-able for screen testers (e.g.boolean
boolean
boolean
Internal use only.Request if of the last request that added a message.getText()
static void
initAvoidDoubleOccuranceOfMessages
(boolean value) If switched to true then new messages will be checked against the list of already passed messages.void
onAutoClear
(javax.faces.event.ActionEvent e) Internal use only.void
onCloseMessagesArea
(javax.faces.event.ActionEvent event) Internal use only.void
onToggleMessagesArea
(javax.faces.event.ActionEvent event) Internal use only.static ModalPopup
outputAlert
(String text) Output alert message.static ModalPopup
outputAlert
(String text, String title) Output alert message.static ModalPopup
outputAlert
(String text, String title, String longText) static void
outputError
(String text) Output error message.static void
outputError
(String text, String longText) static void
outputMessage
(String text) Output normal status message.static void
outputMessage
(String text, String longText) static ModalPopup
outputMessageWithPopup
(String text) static ModalPopup
outputMessageWithPopup
(String text, String longText) static ModalPopup
outputMessageWithPopup
(String text, String title, String longText) static void
outputSuccess
(String text) Output success message.static void
outputSuccess
(String text, String longText) static ModalPopup
outputSuccessWithPopup
(String text) static ModalPopup
outputSuccessWithPopup
(String text, String longText) static ModalPopup
outputSuccessWithPopup
(String text, String title, String longText) static void
outputWarning
(String text) Output warning message.static void
outputWarning
(String text, String longText) static ModalPopup
outputWarningWithPopup
(String text) static ModalPopup
outputWarningWithPopup
(String text, String longText) static ModalPopup
outputWarningWithPopup
(String text, String title, String longText) void
Internal use only.static void
If the statusbar was cleared you may re-apply the messages that were shown before the clearing.void
If the statusbar was cleared you may re-apply the messages that were shown before the clearing.static void
setAvoidConcatenationOfMessagesInPopup
(boolean avoidConcatenationOfMessagesInPopup) If passing multiple messages into the status bar then by default the text of the messages are concatenated within the message popup.void
setBgpaint
(String value) void
void
setHtStyle
(String value) void
static void
setImmediatelyShowAllMessages
(boolean immediatelyShowAllMessages) This flag defined what happens if mulitple messages are output within one request processing.void
setImmediatelyShowAllMessagesForInstance
(boolean immediatelyShowAllMessages) Similar to methodsetImmediatelyShowAllMessages(boolean)
, but: now defined on instance level, not on static level (addressing the central status bar).void
setMessagesPane
(BaseComponent pane) Internal use only.void
void
setTextColor
(String value) void
Internal use only.writeAlert
(String text) writeAlert
(String text, String title) Output alert message.void
writeError
(String text) Output error message into this concrete instance.void
writeError
(String text, String longText) void
writeMessage
(String text) Output normal status message into this concrete instance.void
writeMessage
(String text, String longText) writeMessageWithPopup
(String text) writeMessageWithPopup
(String text, String longText) writeMessageWithPopup
(String text, String title, String longText) void
writeSuccess
(String text) Output success message into this concrete instance.void
writeSuccess
(String text, String longText) writeSuccessWithPopup
(String text) writeSuccessWithPopup
(String text, String longText) writeSuccessWithPopup
(String text, String title, String longText) void
writeWarning
(String text) Output warning message into this concrete instance.void
writeWarning
(String text, String longText) writeWarningWithPopup
(String text) writeWarningWithPopup
(String text, String longText) writeWarningWithPopup
(String text, String title, String longText)
-
Field Details
-
INTBGPAINT_MESSAGE
-
INTBGPAINT_ERROR
-
INTBGPAINT_WARNING
-
INTBGPAINT_SUCCESS
-
INTBGPAINT_BACK
-
SBTEXTCOLOR_ERROR
-
SBTEXTCOLOR_WARNING
-
SBTEXTCOLOR_SUCCESS
-
SBTEXTCOLOR_MESSAGE
-
POPUPTEXTCOLOR_ERROR
-
POPUPTEXTCOLOR_WARNING
-
POPUPTEXTCOLOR_SUCCESS
-
POPUPTEXTCOLOR_MESSAGE
-
TYPE_MESSAGE
public static final int TYPE_MESSAGE- See Also:
-
TYPE_SUCCESS
public static final int TYPE_SUCCESS- See Also:
-
TYPE_WARNING
public static final int TYPE_WARNING- See Also:
-
TYPE_ERROR
public static final int TYPE_ERROR- See Also:
-
TYPE_ALERT
public static final int TYPE_ALERT- See Also:
-
POPUP_OPACITY
public static int POPUP_OPACITYOpacity of statusbar popups. Default: true. -
POPUP_UNDECORATED
public static boolean POPUP_UNDECORATEDDefinition if status bar popups are opened undecorated or not. Default: true. -
POPUP_ANIMATED
public static boolean POPUP_ANIMATEDDefinition if status bar popups are opened with some animation. Default: true.
-
-
Constructor Details
-
Statusbar
public Statusbar() -
Statusbar
-
-
Method Details
-
initAvoidDoubleOccuranceOfMessages
public static void initAvoidDoubleOccuranceOfMessages(boolean value) If switched to true then new messages will be checked against the list of already passed messages. If the new message is already contained then it wille not be added once again. -
setAvoidConcatenationOfMessagesInPopup
public static void setAvoidConcatenationOfMessagesInPopup(boolean avoidConcatenationOfMessagesInPopup) If passing multiple messages into the status bar then by default the text of the messages are concatenated within the message popup. By setting this property to true only the last message will be shown within the popup. -
avoidNextClearing
public static void avoidNextClearing()By default the statusbar is cleared with each roundtrip. By calling this method you can avoid this clearing and can prolong the lifecycle of the statusbar content for one further roundtrip. -
outputMessage
Output normal status message. -
outputMessage
-
outputMessageWithPopup
-
outputMessageWithPopup
-
outputMessageWithPopup
-
writeMessage
Output normal status message into this concrete instance. -
writeMessage
-
writeMessageWithPopup
-
writeMessageWithPopup
-
writeMessageWithPopup
-
outputSuccess
Output success message. -
outputSuccess
-
outputSuccessWithPopup
-
outputSuccessWithPopup
-
outputSuccessWithPopup
-
writeSuccess
Output success message into this concrete instance. -
writeSuccess
-
writeSuccessWithPopup
-
writeSuccessWithPopup
-
writeSuccessWithPopup
-
outputWarning
Output warning message. -
outputWarning
-
outputWarningWithPopup
-
outputWarningWithPopup
-
outputWarningWithPopup
-
writeWarning
Output warning message into this concrete instance. -
writeWarning
-
writeWarningWithPopup
-
writeWarningWithPopup
-
writeWarningWithPopup
-
outputError
Output error message. -
outputError
-
writeError
Output error message into this concrete instance. -
writeError
-
outputAlert
Output alert message. This message must be confirmed by the user. -
outputAlert
Output alert message. This message must be confirmed by the user. With this method you can add an explicit title for the popup that is opened. -
outputAlert
-
writeAlert
-
writeAlert
Output alert message. This message must be confirmed by the user. With this method you can add an explicit title for the popup that is opened. -
getMessages
Messages that are currently shown in the status bar. -
getMessageToClientTester
Message that is sent to the client side and that contains application information that is read-able for screen testers (e.g. Selenium). -
getMessagesAsXML
-
getRequestIdOfLastMessage
Request if of the last request that added a message. -
setImmediatelyShowAllMessages
public static void setImmediatelyShowAllMessages(boolean immediatelyShowAllMessages) This flag defined what happens if mulitple messages are output within one request processing. By default ("false") the last message is output to the status bar and the user can open an area, in which all messages are shown by explicitly clicking onto a corresponding icon.
If setting this property to "true" then the list of messages is opened immediately, i.e. the user does not have to explicitly click the icon. -
getImmediatelyShowAllMessages
public static boolean getImmediatelyShowAllMessages() -
setImmediatelyShowAllMessagesForInstance
public void setImmediatelyShowAllMessagesForInstance(boolean immediatelyShowAllMessages) Similar to methodsetImmediatelyShowAllMessages(boolean)
, but: now defined on instance level, not on static level (addressing the central status bar). -
getImmediatelyShowAllMessagesForInstance
public boolean getImmediatelyShowAllMessagesForInstance() -
clear
public void clear()Clear statusbar output. -
reoutputLastMessages
public static void reoutputLastMessages()If the statusbar was cleared you may re-apply the messages that were shown before the clearing. The function is only executed if the status bar is empty, i.e. no new message was written to the status bar. -
rewriteLastMessages
public void rewriteLastMessages()If the statusbar was cleared you may re-apply the messages that were shown before the clearing. The function is only executed if the status bar is empty, i.e. no new message was written to the status bar. -
setText
-
getText
-
setTextColor
-
getTextColor
-
getClearTimerDuration
public int getClearTimerDuration() -
setImage
-
getImage
-
getChangeCounter
public int getChangeCounter() -
getPopupimage
-
setBgpaint
-
getBgpaint
-
setFont
-
getFont
-
setHtStyle
-
getHtStyle
-
getSoundTrigger
-
getMoreThanOneMessageIconShown
public boolean getMoreThanOneMessageIconShown() -
getMoreThanOneMessage
public boolean getMoreThanOneMessage() -
getMessagesAreaShown
public boolean getMessagesAreaShown() -
onToggleMessagesArea
public void onToggleMessagesArea(javax.faces.event.ActionEvent event) Internal use only. -
onCloseMessagesArea
public void onCloseMessagesArea(javax.faces.event.ActionEvent event) Internal use only. -
setMessagesPane
Internal use only. -
destroy
public void destroy() -
autoClearStatusbar
public static void autoClearStatusbar(int duration) Advise status bar to clear its content a certain duration (in milliseconds). -
autoClearStatusbarContent
public void autoClearStatusbarContent(int duration) Advise status bar to clear its content a certain duration (in milliseconds). -
onAutoClear
public void onAutoClear(javax.faces.event.ActionEvent e) Internal use only. -
checkIfMessageAlreadyWasOutput
Checks if a message already was output to the status bar.- Parameters:
messageType
- One of the TYPE_* constant values.messageText
-- Returns:
- -1 => not found, >= 0 => found
-
checkIfMessageAlreadyWasOutput
Checks if a message already was output to the status bar.- Returns:
- -1 => not found, >= 0 => found
-
registerStatusbarComponent
Internal use only. Register status bar component. Purpose: if there is no explicit registration then the central status bar component will be rendered that is defined in modalpopup.jsp. -
unregisterStatusbarComponent
Internal use only. -
getRenderDefaultStatusbar
public boolean getRenderDefaultStatusbar()Internal use only. Check if central status bar is to be rendered. It only is rendered if there is no other status bar component which registered.
-