public interface IVHB
IViewHints
builder class.
IViewHints
with multiple properties can be built by calling the short setter methods for each property (they return the builder so this can be
chained), and finally calling the build()
method to obtain the IViewHints
reference like this:
IViewHints vh = services.getSettingsGui().newVHB().sstext( "pixel" ).rhtml( helpRes ).build();
ISettingsUtils.newVHB()
Modifier and Type | Method and Description |
---|---|
IViewHints |
build()
Builds and returns the
IViewHints . |
IVHB |
cols(java.lang.Integer columns)
Sets the columns count to be used for the setting component if supported.
|
IVHB |
compConfigurer(ICompConfigurer compConfigurer)
Sets the setting component configurer.
|
IVHB |
dtitle(java.lang.String dialogTitle)
Sets the dialog title.
|
IVHB |
help(IRHtml helpRhtml)
Sets the help HTML resource of the setting.
|
IVHB |
reqReg()
Sets the edit registration requirement to
true . |
IVHB |
ricon(IRIcon ricon)
Sets the setting ricon.
|
IVHB |
rows(java.lang.Integer rows)
Sets the rows count to be used for the setting component if supported.
|
IVHB |
ssCompFactory(ISsCompFactory<? extends ISetting<?>> ssCompFactory)
Sets the custom subsequent component factory.
|
IVHB |
sstext(java.lang.String subsequentText)
Sets the subsequent text of the setting component.
|
IVHB ricon(IRIcon ricon)
ricon
- setting ricon to be setthis
for chainingIVHB sstext(java.lang.String subsequentText)
subsequentText
- subsequent text of the setting component to be setthis
for chainingIVHB help(IRHtml helpRhtml)
helpRhtml
- help HTML resource of the setting to be setthis
for chainingIVHB dtitle(java.lang.String dialogTitle)
dialogTitle
- dialog title to be setthis
for chainingIVHB ssCompFactory(ISsCompFactory<? extends ISetting<?>> ssCompFactory)
ssCompFactory
- custom subsequent component factory to be setthis
for chainingIVHB compConfigurer(ICompConfigurer compConfigurer)
compConfigurer
- setting component configurer to be setthis
for chainingIVHB reqReg()
true
.this
for chainingIVHB rows(java.lang.Integer rows)
rows
- rows count to be setthis
for chainingIVHB cols(java.lang.Integer columns)
columns
- columns count to be setthis
for chainingIViewHints build()
IViewHints
.IViewHints
from the configured parameters
This API documentation is public and is intended for / allowed to be used by anyone.
Scelight home page: https://sites.google.com/site/scelight/
Scelight is a trademark of András Belicza. Copyright © András Belicza, 2013-2015. All rights reserved.