public class EditorDescription extends Object
| Constructor and Description |
|---|
EditorDescription()
Creates a new EditorDescription object.
|
EditorDescription(String caption)
Creates a new EditorDescription object with a given caption.
|
EditorDescription(String caption,
boolean defaultVertical,
boolean defaultLabelFlushed)
Creates a new EditorDescription object with a given caption and
given default options.
|
| Modifier and Type | Method and Description |
|---|---|
CheckboxPart |
addCheckboxPart(ParameterDescriptor paramDescriptor)
Adds a check box UI part to this editor description.
|
CheckListPart |
addCheckListPart(String label,
int heightHint)
Adds a check list UI part to this editor description.
|
CodeFinderPart |
addCodeFinderPart(ParameterDescriptor paramDescriptor)
Adds a code-finder panel part to this editor description.
|
FolderInputPart |
addFolderInputPart(ParameterDescriptor paramDescriptor,
String browseTitle)
Adds a folder input field UI part to this editor description.
|
ListSelectionPart |
addListSelectionPart(ParameterDescriptor paramDescriptor,
String[] choices)
Adds a selection list UI part to this editor description.
|
TextInputPart |
addOptionalTextInputPart(ParameterDescriptor paramDescriptor)
Adds an optional text input UI part to this editor description.
|
PathInputPart |
addPathInputPart(ParameterDescriptor paramDescriptor,
String browseTitle,
boolean forSaveAs)
Adds a path input field UI part to this editor description.
|
SeparatorPart |
addSeparatorPart()
Adds a separator part to this editor description.
|
SpinInputPart |
addSpinInputPart(ParameterDescriptor paramDescriptor)
Adds a spin part to this editor description.
|
TextInputPart |
addTextInputPart(ParameterDescriptor paramDescriptor)
Adds a default text input UI part to this editor description.
|
TextLabelPart |
addTextLabelPart(String text) |
String |
getCaption()
Gets the caption for this editor.
|
AbstractPart |
getDescriptor(String name)
Gets the descriptor for a given UI part.
|
Map<String,AbstractPart> |
getDescriptors()
Gets a map of the descriptor of all UI parts for this editor.
|
void |
setCaption(String caption)
Sets the caption for this editor.
|
public EditorDescription()
public EditorDescription(String caption)
caption - the caption of the editor.public EditorDescription(String caption, boolean defaultVertical, boolean defaultLabelFlushed)
caption - the caption of the editor.defaultVertical - default value for this option.defaultLabelFlushed - default value for this option.public String getCaption()
public void setCaption(String caption)
caption - the caption for this editor.public Map<String,AbstractPart> getDescriptors()
public AbstractPart getDescriptor(String name)
name - the name of the UI part to lookup.public TextInputPart addTextInputPart(ParameterDescriptor paramDescriptor)
paramDescriptor - the parameter descriptor for this UI part.public TextInputPart addOptionalTextInputPart(ParameterDescriptor paramDescriptor)
paramDescriptor - the parameter descriptor for this UI part.public CheckboxPart addCheckboxPart(ParameterDescriptor paramDescriptor)
paramDescriptor - the parameter descriptor for this UI part.public CheckListPart addCheckListPart(String label, int heightHint)
label - the text of the label above the listheightHint - the suggested height of the list.public ListSelectionPart addListSelectionPart(ParameterDescriptor paramDescriptor, String[] choices)
paramDescriptor - the parameter descriptor for this UI part.choices - the list of items values that can be selected.public PathInputPart addPathInputPart(ParameterDescriptor paramDescriptor, String browseTitle, boolean forSaveAs)
paramDescriptor - the parameter descriptor for this UI part.browseTitle - the title to use for the path browsing dialog.forSaveAs - true if the path is to save a file (vs to open one).public FolderInputPart addFolderInputPart(ParameterDescriptor paramDescriptor, String browseTitle)
paramDescriptor - the parameter descriptor for this UI part.browseTitle - the title to use for the directory browsing dialog.public CodeFinderPart addCodeFinderPart(ParameterDescriptor paramDescriptor)
paramDescriptor - the parameter descriptor for this UI part.public SpinInputPart addSpinInputPart(ParameterDescriptor paramDescriptor)
paramDescriptor - the parameter descriptor for this UI part.public SeparatorPart addSeparatorPart()
public TextLabelPart addTextLabelPart(String text)
Copyright © 2021. All rights reserved.