Class MessageArea
java.lang.Object
org.eclipse.nebula.widgets.opal.dialog.DialogArea
org.eclipse.nebula.widgets.opal.dialog.MessageArea
public class MessageArea extends DialogArea
Instances of this class are message areas
-
Field Summary
-
Constructor Summary
Constructors Constructor Description MessageArea(Dialog parent)
Constructor -
Method Summary
Modifier and Type Method Description MessageArea
addCheckBox(java.lang.String label, boolean selection)
Add a check boxMessageArea
addChoice(int defaultSelection, ChoiceItem... items)
Add a choiceMessageArea
addProgressBar(int mininum, int maximum, int value)
Add a progress barMessageArea
addRadioButtons(int defaultSelection, java.lang.String... values)
Add a choice composed of radio buttonsMessageArea
addTextBox(java.lang.String value)
Add a text box for inputboolean
getCheckBoxValue()
int
getChoice()
java.lang.Throwable
getException()
int
getHeight()
org.eclipse.swt.graphics.Image
getIcon()
int
getProgressBarMaximumValue()
int
getProgressBarMinimumValue()
int
getProgressBarValue()
int
getRadioChoice()
java.lang.String
getText()
java.lang.String
getTextBoxValue()
java.lang.String
getTitle()
(package private) void
hideException()
Hide the exception panelboolean
isVerticalScrollbar()
void
render()
Render the content of an areaMessageArea
setException(java.lang.Throwable exception)
void
setHeight(int height)
MessageArea
setIcon(org.eclipse.swt.graphics.Image icon)
void
setProgressBarMaximumValue(int progressBarMaximumValue)
void
setProgressBarMinimumValue(int progressBarMinimumValue)
void
setProgressBarValue(int progressBarValue)
MessageArea
setText(java.lang.String text)
MessageArea
setTitle(java.lang.String title)
void
setVerticalScrollbar(boolean verticalScrollbar)
(package private) void
showException()
Show the exception panelMethods inherited from class org.eclipse.nebula.widgets.opal.dialog.DialogArea
getBiggerFont, getFewerDetailsImage, getGreyColor, getMoreDetailsImage, getNormalFont, getTitleColor, isInitialised, setInitialised
-
Constructor Details
-
MessageArea
Constructor- Parameters:
parent
- dialog that is composed of this message area
-
-
Method Details
-
addChoice
Add a choice- Parameters:
defaultSelection
- default selectionitems
- a list of the choice item- Returns:
- the current message area
-
addRadioButtons
Add a choice composed of radio buttons- Parameters:
defaultSelection
- default selectionvalues
- values- Returns:
- the current message area
-
addTextBox
Add a text box for input- Parameters:
value
- defaut value of the textbox- Returns:
- the current message area
-
addProgressBar
Add a progress bar- Parameters:
mininum
- minimum valuemaximum
- maximum valuevalue
- default value- Returns:
- the current message area
-
addCheckBox
Add a check box- Parameters:
label
- label to displayselection
- default value of the check box- Returns:
- this message area
-
render
public void render()Description copied from class:DialogArea
Render the content of an area- Specified by:
render
in classDialogArea
- See Also:
DialogArea.render()
-
hideException
void hideException()Hide the exception panel -
showException
void showException()Show the exception panel -
getTitle
public java.lang.String getTitle()- Returns:
- the title
-
setTitle
- Parameters:
title
- the title to set- Returns:
- the current message area
-
getIcon
public org.eclipse.swt.graphics.Image getIcon()- Returns:
- the icon
-
setIcon
- Parameters:
icon
- the icon to set
-
getText
public java.lang.String getText()- Returns:
- the text
-
setText
- Parameters:
text
- the text to set
-
getRadioChoice
public int getRadioChoice()- Returns:
- the radio choice
-
getException
public java.lang.Throwable getException()- Returns:
- the exception
-
setException
- Parameters:
exception
- the exception to set- Returns:
-
getChoice
public int getChoice()- Returns:
- the choice
-
getTextBoxValue
public java.lang.String getTextBoxValue()- Returns:
- the value stored in the text box
-
getProgressBarMinimumValue
public int getProgressBarMinimumValue()- Returns:
- the progress bar minimum value
-
setProgressBarMinimumValue
public void setProgressBarMinimumValue(int progressBarMinimumValue)- Parameters:
progressBarMinimumValue
- the progress bar minimum value to set
-
getProgressBarMaximumValue
public int getProgressBarMaximumValue()- Returns:
- the progress bar maximum value
-
setProgressBarMaximumValue
public void setProgressBarMaximumValue(int progressBarMaximumValue)- Parameters:
progressBarMaximumValue
- the progress bar minimum value to set
-
getProgressBarValue
public int getProgressBarValue()- Returns:
- the progress bar value
-
setProgressBarValue
public void setProgressBarValue(int progressBarValue)- Parameters:
progressBarValue
- the progress bar value to set
-
isVerticalScrollbar
public boolean isVerticalScrollbar()- Returns:
- the verticalScrollbar
-
setVerticalScrollbar
public void setVerticalScrollbar(boolean verticalScrollbar)- Parameters:
verticalScrollbar
- the verticalScrollbar to set
-
getHeight
public int getHeight()- Returns:
- the height
-
setHeight
public void setHeight(int height)- Parameters:
height
- the height to set
-
getCheckBoxValue
public boolean getCheckBoxValue()- Returns:
- the check box vqlue
-