Package com.iizix.gyro
Interface IMessageBox
- All Known Subinterfaces:
IAppSessionGyro,IClientSessionGyro,IComponent,IContentItem,IEntry,IEUIComp,IEUICompCommon,IEUIContainer,IEUIPanel,IUIAction,IUIAnimatedSingleIndexedSelectionComp,IUIBooleanSelectionComp,IUICellSelectionComp,IUICheck2Component,IUICheckComponent,IUIComp,IUICompRelativeTarget,IUIContainer,IUIDateTimeComponent,IUIDateValueComponent,IUIDoubleRangeValueComponent,IUIDoubleValueComponent,IUIHint,IUIIndexedSelectionComp,IUILabelForTarget,IUINullableValueComponent,IUIRadioComponent,IUISelectionComp,IUISingleIndexedSelectionComp,IUITimeValueComponent,IUITriStateSelectionComp,IUIValueComponent,IVSComponent,IVSMessageComponent
- All Known Implementing Classes:
AbstractContentUIContainer,AbstractUIAction,AppSessionGyro,BaseEvent,CalendarEvent,ClientSessionGyro,ECalendarEvent,EditorVirtualSpace,EditorVSAction,EditorVSColumnHeader,EditorVSField,EditorVSGroup,EditorVSRow,EditorVSTable,EMapMarkerProp,EMapMarkers,EMLGroup,EMList,EMLItemProp,EMUIHeading,EMUISimpleDialog,EMUISwitch,EMUITabBar,EUIAccordion,EUIButton,EUICalendar,EUICalendarList,EUIChart,EUICheckBox,EUICheckedMenuItem,EUIComboBox,EUIContainer,EUIContextMenu,EUIDateTime,EUIDialog,EUIEmpty,EUIGauge,EUIImage,EUIImage2,EUILabel,EUIMap,EUIMedia,EUIMenu,EUIMenuBar,EUIMenuItem,EUIMenuSeparator,EUIOutput,EUIPanel,EUIPanelPart,EUIPanelPartCnr,EUIProgress,EUIRadioButton,EUIRadioMenuItem,EUISlider,EUISpinner,EUISwapContainer,EUITabContainer,EUITable,EUITableColumn,EUIText,EUITextArea,EUITitlePane,MapMarkerProp,MapMarkers,MessageBox,MLGroup,MList,MLItemProp,MUIHeading,MUISimpleDialog,MUISwitch,MUITabBar,UIAbstractListChoice,UIAccordion,UIActionEvent,UIBackEvent,UIBaseEvent,UIButton,UICalendar,UICalendarList,UIChart,UICheckBox,UICheckedMenuItem,UIComboBox,UIComp,UIConnectEvent,UIContainer,UIContextMenu,UICreateEvent,UIDateTime,UIDestroyEvent,UIDialog,UIEmpty,UIFocusEvent,UIGauge,UIImage,UIImage2,UILabel,UIMap,UIMedia,UIMenu,UIMenuBar,UIMenuItem,UIMenuSeparator,UIOutput,UIPanel,UIPanelBase,UIPanelPart,UIPanelPartCnr,UIProgress,UIRadioButton,UIRadioMenuItem,UISelectionEvent,UISlider,UISpinner,UISwapContainer,UITabContainer,UITable,UITableColumn,UIText,UITextArea,UITextChangeEvent,UITitlePane,UIValueChangeEvent,VirtualSpace,VSAction,VSActionEvent,VSBaseEvent,VSBaseEventWithTrigger,VSChangeEvent,VSColumnHeader,VSComponent,VSCreateEvent,VSDestroyEvent,VSField,VSFieldEvent,VSFocusEvent,VSGroup,VSRow,VSStateEvent,VSTable
- Functional Interface:
- This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface IMessageBoxThe message box API enables showing a message box for a specific client session for user interaction. If done on the application session, the first client session's reply will be used, and the other client sessions' message box will be disposed of.The processing is model for the message box reply is a callback and can be aborted in case of client session failure if directed to a specific client session and it is closed. If the message box is displayed for an application session and that one is closed, no callback will be done.
- Author:
- Christopher Mindus
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classIMessageBox.IconThe enum's for icons.
Field Summary
Fields Modifier and Type Field Description static intICON_ERRORIcon option: error/critical/stop sign.static intICON_INFORMATIONIcon option: informational.static IMessageBox.Icon[]ICON_MAPTable mapping icon values to Icon enum.static intICON_NONEIcon option: none.static intICON_QUESTIONIcon option: question mark.static intICON_WARNINGIcon option: warning.
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default voidmessageBox(IMessageBoxReply reply, int icon, java.lang.String title, java.lang.String message)Displays a message box with the specified title and message.default voidmessageBox(IMessageBoxReply reply, int icon, java.lang.String title, java.lang.String message, java.lang.String... buttons)Displays a message box with the specified title and message.voidmessageBox(IMessageBoxReply reply, IMessageBox.Icon icon, KString title, KString message, KString... buttons)Displays a message box with the specified title and message.
Field Detail
ICON_NONE
static final int ICON_NONE
Icon option: none.- See Also:
- Constant Field Values
ICON_INFORMATION
static final int ICON_INFORMATION
Icon option: informational.- See Also:
- Constant Field Values
ICON_QUESTION
static final int ICON_QUESTION
Icon option: question mark.- See Also:
- Constant Field Values
ICON_WARNING
static final int ICON_WARNING
Icon option: warning.- See Also:
- Constant Field Values
ICON_ERROR
static final int ICON_ERROR
Icon option: error/critical/stop sign.- See Also:
- Constant Field Values
ICON_MAP
static final IMessageBox.Icon[] ICON_MAP
Table mapping icon values to Icon enum.
Method Detail
messageBox
default void messageBox(IMessageBoxReply reply, int icon, java.lang.String title, java.lang.String message)
Displays a message box with the specified title and message. The icon can be specified as Informational, Question, Error or None.- Parameters:
reply- The reply callback that is called when the user chooses a button or session is closed,nullfor none.icon- Icon to display, see theICON_*values, e.g.ICON_INFORMATIONtitle- The title string, null for none.message- The message to display, must be non-null.- Throws:
java.lang.NullPointerException- Ifmessageis null.
messageBox
default void messageBox(IMessageBoxReply reply, int icon, java.lang.String title, java.lang.String message, java.lang.String... buttons)
Displays a message box with the specified title and message. The icon can be specified as Informational, Question, Error or None.- Parameters:
reply- The reply callback that is called when the user chooses a button or session is closed,nullfor none.icon- Icon to display, see theICON_*values, e.g.ICON_INFORMATIONtitle- The title string, null for none.message- The message to display, must be non-null.buttons- The strings for the buttons to display, if none, just anOKbutton is displayed. This array of buttons defined the index value returned by this method.- Throws:
java.lang.NullPointerException- Ificonormessageis null.
messageBox
void messageBox(IMessageBoxReply reply, IMessageBox.Icon icon, KString title, KString message, KString... buttons)
Displays a message box with the specified title and message.- Parameters:
reply- The reply callback that is called when the user chooses a button or session is closed,nullfor none.icon- Icon to display, see the{link Icon}enumeration.title- The title string, must be non-null.message- The message to display, must be non-null.buttons- The strings for the buttons to display, if none, just anOKbutton is displayed. This array of buttons defined the index value returned by this method.- Throws:
java.lang.NullPointerException- Ificonormessageis null, or if any of the elements inbuttonsarray is null.