public class UIHints extends Object
UIHints
may be associated with a SBPropertyDescriptor
in order
to provide the Studio environment with additional hints regarding how to display
a property.
If you wish to toggle the UI widget enablement state for a property, see Parameterizable
.Modifier and Type | Class and Description |
---|---|
static class |
UIHints.TextWidthHint
Used to request a particular width for text-field like controls (including but
not limited to text fields and combo/drop-downs).
|
Modifier and Type | Field and Description |
---|---|
boolean |
maskStringDisplay
Set a hint for the associated property to mask displayed characters when
presented to the end-user.
|
int |
numLines
Set a hint for the associated property to be displayed as a multiline editable
box of height (number of lines)
size . |
String[] |
proposals
Set a hint for an associated String property to propose to the user
the following values.
|
String |
tab
Name to give the tab in which the associated property will be created in, when
displayed in the Properties View of StreamBase Studio.
|
String[] |
tableColumnNames
Set a hint for the associated table property to be displayed with the following
column names.
|
UIHints.TextWidthHint |
textWidthHint
Set a hint for text-field like properties to have a relative width.
|
Modifier and Type | Method and Description |
---|---|
static UIHints |
create()
Creates a new
UIHints with all values initialized to default |
UIHints |
setMaskStringDisplay(boolean maskStringDisplay)
Sets the mask hint, applicable to String property types.
|
UIHints |
setNumLines(int numLines)
Sets the number of lines to display this property as, applicable to String property types.
|
UIHints |
setProposals(String... proposals)
Set string proposals that will be offered to the user when editing
an associated String property
|
UIHints |
setTab(String tab)
Sets the tab name hint.
|
UIHints |
setTableColumnNames(String... tableColumnNames)
Set column names to use for properties displayed in a user interface Table
|
UIHints |
setTextWidth(UIHints.TextWidthHint width)
Set the desired width hint for text-field-like controls
|
public String tab
Schema
properties.
public boolean maskStringDisplay
false
.public int numLines
size
. Valid only for a String property.
1
.public String[] tableColumnNames
public String[] proposals
EnumPropertyDescriptor
or JavaEnumPropertyDescriptor
.public UIHints.TextWidthHint textWidthHint
UIHints.TextWidthHint
public static UIHints create()
UIHints
with all values initialized to defaultUIHints
public UIHints setTab(String tab)
&
character in the String.
Note that Schema
properties are always placed in a special tab.tab
- the tab nameUIHints.tab
public UIHints setMaskStringDisplay(boolean maskStringDisplay)
maskStringDisplay
- whether to set the string mask hint or notUIHints.maskStringDisplay
public UIHints setNumLines(int numLines)
numLines
- the number of lines desiredUIHints.numLines
public UIHints setTableColumnNames(String... tableColumnNames)
tableColumnNames
- the names of the columns, from first to lastUIHints.tableColumnNames
public UIHints setProposals(String... proposals)
proposals
- string values that will be proposed to the userUIHints.proposals
public UIHints setTextWidth(UIHints.TextWidthHint width)
width
- the desired width