Package org.eclnt.jsfserver.defaultscreens

Class Statusbar

java.lang.Object
org.eclnt.jsfserver.defaultscreens.Statusbar
All Implemented Interfaces:
Serializable
public class Statusbar extends Object implements 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).
See Also:

  • Field Details

    • INTBGPAINT_MESSAGE

      public static String INTBGPAINT_MESSAGE

    • INTBGPAINT_ERROR

      public static String INTBGPAINT_ERROR

    • INTBGPAINT_WARNING

      public static String INTBGPAINT_WARNING

    • INTBGPAINT_SUCCESS

      public static String INTBGPAINT_SUCCESS

    • INTBGPAINT_BACK

      public static String INTBGPAINT_BACK

    • SBTEXTCOLOR_ERROR

      public static String SBTEXTCOLOR_ERROR

    • SBTEXTCOLOR_WARNING

      public static String SBTEXTCOLOR_WARNING

    • SBTEXTCOLOR_SUCCESS

      public static String SBTEXTCOLOR_SUCCESS

    • SBTEXTCOLOR_MESSAGE

      public static String SBTEXTCOLOR_MESSAGE

    • POPUPTEXTCOLOR_ERROR

      public static String POPUPTEXTCOLOR_ERROR

    • POPUPTEXTCOLOR_WARNING

      public static String POPUPTEXTCOLOR_WARNING

    • POPUPTEXTCOLOR_SUCCESS

      public static String POPUPTEXTCOLOR_SUCCESS

    • POPUPTEXTCOLOR_MESSAGE

      public static String 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:

  • Constructor Details

  • 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.

    • initPopupMode

      public static void initPopupMode(Statusbar.ENUMPopupMode mode)

    • 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

      public static void outputMessage(String text)
      Output normal status message.

    • outputMessage

      public static void outputMessage(String text, String longText)

    • outputMessageWithPopup

      public static ModalPopup outputMessageWithPopup(String text)

    • outputMessageWithPopup

      public static ModalPopup outputMessageWithPopup(String text, String longText)

    • outputMessageWithPopup

      public static ModalPopup outputMessageWithPopup(String text, String title, String longText)

    • writeMessage

      public void writeMessage(String text)
      Output normal status message into this concrete instance.

    • writeMessage

      public void writeMessage(String text, String longText)

    • writeMessageWithPopup

      public ModalPopup writeMessageWithPopup(String text)

    • writeMessageWithPopup

      public ModalPopup writeMessageWithPopup(String text, String longText)

    • writeMessageWithPopup

      public ModalPopup writeMessageWithPopup(String text, String title, String longText)

    • outputSuccess

      public static void outputSuccess(String text)
      Output success message.

    • outputSuccess

      public static void outputSuccess(String text, String longText)

    • outputSuccessWithPopup

      public static ModalPopup outputSuccessWithPopup(String text)

    • outputSuccessWithPopup

      public static ModalPopup outputSuccessWithPopup(String text, String longText)

    • outputSuccessWithPopup

      public static ModalPopup outputSuccessWithPopup(String text, String title, String longText)

    • writeSuccess

      public void writeSuccess(String text)
      Output success message into this concrete instance.

    • writeSuccess

      public void writeSuccess(String text, String longText)

    • writeSuccessWithPopup

      public ModalPopup writeSuccessWithPopup(String text)

    • writeSuccessWithPopup

      public ModalPopup writeSuccessWithPopup(String text, String longText)

    • writeSuccessWithPopup

      public ModalPopup writeSuccessWithPopup(String text, String title, String longText)

    • outputWarning

      public static void outputWarning(String text)
      Output warning message.

    • outputWarning

      public static void outputWarning(String text, String longText)

    • outputWarningWithPopup

      public static ModalPopup outputWarningWithPopup(String text)

    • outputWarningWithPopup

      public static ModalPopup outputWarningWithPopup(String text, String longText)

    • outputWarningWithPopup

      public static ModalPopup outputWarningWithPopup(String text, String title, String longText)

    • writeWarning

      public void writeWarning(String text)
      Output warning message into this concrete instance.

    • writeWarning

      public void writeWarning(String text, String longText)

    • writeWarningWithPopup

      public ModalPopup writeWarningWithPopup(String text)

    • writeWarningWithPopup

      public ModalPopup writeWarningWithPopup(String text, String longText)

    • writeWarningWithPopup

      public ModalPopup writeWarningWithPopup(String text, String title, String longText)

    • outputError

      public static void outputError(String text)
      Output error message.

    • outputError

      public static void outputError(String text, String longText)

    • writeError

      public void writeError(String text)
      Output error message into this concrete instance.

    • writeError

      public void writeError(String text, String longText)

    • outputAlert

      public static ModalPopup outputAlert(String text)
      Output alert message. This message must be confirmed by the user.

    • outputAlert

      public static ModalPopup outputAlert(String text, String title)
      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

      public static ModalPopup outputAlert(String text, String title, String longText)

    • writeAlert

      public ModalPopup writeAlert(String text)

    • writeAlert

      public ModalPopup writeAlert(String text, String title)
      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

      public List<Statusbar.StatusBarMessage> getMessages()
      Messages that are currently shown in the status bar.

    • getMessageToClientTester

      public String 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

      public String getMessagesAsXML()

    • getRequestIdOfLastMessage

      public String 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 method setImmediatelyShowAllMessages(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

      public void setText(String value)

    • getText

      public String getText()

    • setTextColor

      public void setTextColor(String value)

    • getTextColor

      public String getTextColor()

    • getClearTimerDuration

      public int getClearTimerDuration()

    • setImage

      public void setImage(String value)

    • getImage

      public String getImage()

    • getChangeCounter

      public int getChangeCounter()

    • getPopupimage

      public String getPopupimage()

    • setBgpaint

      public void setBgpaint(String value)

    • getBgpaint

      public String getBgpaint()

    • setFont

      public void setFont(String value)

    • getFont

      public String getFont()

    • setHtStyle

      public void setHtStyle(String value)

    • getHtStyle

      public String getHtStyle()

    • getSoundTrigger

      public Trigger getSoundTrigger()

    • getMoreThanOneMessageIconShown

      public boolean getMoreThanOneMessageIconShown()

    • getMoreThanOneMessage

      public boolean getMoreThanOneMessage()

    • getMessagesAreaShown

      public boolean getMessagesAreaShown()

    • onToggleMessagesArea

      public void onToggleMessagesArea(ActionEvent event)
      Internal use only.

    • onCloseMessagesArea

      public void onCloseMessagesArea(ActionEvent event)
      Internal use only.

    • setMessagesPane

      public void setMessagesPane(BaseComponent pane)
      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(ActionEvent e)
      Internal use only.

    • checkIfMessageAlreadyWasOutput

      public int checkIfMessageAlreadyWasOutput(int messageType, String messageText)
      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

      public int checkIfMessageAlreadyWasOutput(String messageText)
      Checks if a message already was output to the status bar.
      Returns:
      -1 => not found, >= 0 => found

    • registerStatusbarComponent

      public void registerStatusbarComponent(String id)
      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

      public void unregisterStatusbarComponent(String id)
      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.