GUIInput

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

rs.sol.soloist.server.guiconfiguration.elementcomponents
Class GUIInput

java.lang.Object
  rs.sol.soloist.server.uml.commonimplementation.runtime._ClassifierInstance
      rs.sol.soloist.server.uml.commonimplementation.runtime._ClassInstance
          rs.sol.soloist.server.javaimpl.runtime.SOLoistClassInstance
              rs.sol.soloist.server.builtindomains.common.ObjectOfClass
                  rs.sol.soloist.server.guiconfiguration.construction.GUIComponent
                      rs.sol.soloist.server.guiconfiguration.elementcomponents.GUIElementComponent
                          rs.sol.soloist.server.guiconfiguration.elementcomponents.GUIInput

All Implemented Interfaces:: IElementPresentationProvider, IUpdatable, rs.sol.soloist.server.uml.concepts.IElement, IClassifierInstance, IClassInstance, IRTElement

public class GUIInput
extends GUIElementComponent
extends GUIElementComponent

A class that covers a variaty of widgets and input controls (fields, lists, combo boxes, suggest boxes, trees, and tables) that serve to help users pick or specify a value or values (both class or a data type instances) from the domain object space. Values can be either selected or picked from the provided collection of values, like selecting a value in a list, or they can be specified by the user, like typing-in a number in a text box. Non of the values are being submitted automatically to the object space on the server. This is the main difference between these types of widgets and those created by using GUIEdit class which have option to submit selected or specified values to the server automatically.

The selected or specified values are always provided on the value output pin (opValue() method) of this widget, so they can be sent to other widgets using the widget binding mechanism.

Different types of widgets can be produced using this class, so not all available methods are valid for each type of widget. Each method specifies what types of widgets support it.

Author:: SOL Expert Group
See Also:: GUIElementComponent

Nested Class Summary
`static class`	`GUIInput.FQPropertyNames` Deprecated. Not for public use.
`static class`	`GUIInput.PROPERTIES` Deprecated. Not for public use.

Field Summary
`static IClass`	`CLASSIFIER` UML class reference
`static java.lang.String`	`FQ_TYPE_NAME` Fully qualified UML class name

Fields inherited from class rs.sol.soloist.server.guiconfiguration.elementcomponents.GUIElementComponent
`clearValue, input, kind, value, widget`

Fields inherited from class rs.sol.soloist.server.guiconfiguration.construction.GUIComponent
`addStyle, context, description, enabled, init, inputBindings, layoutData, logger, name, outputBindings, ownerTable, parent, removeStyle, show, showInParent, styleName, tooltip, visible`

Constructor Summary
`GUIInput()`

Method Summary
`void`	`addColumn(java.lang.String name, GUIComponent c)` Adds the column header name and the corresponding column component.
`void`	`addColumnComponent(GUIComponent c)` Adds the new component to the collection of column components.
`void`	`addColumnName(java.lang.String name)` Adds the column name of this table.
`void`	`addInitialValue(rs.sol.soloist.server.uml.concepts.IElement el)` Adds the new initial value.
`void`	`clearColumnComponents()` Clears the column components collection.
`void`	`clearColumnNames()` Clears the column names of this table.
`void`	`clearInitialValues()` Clears the initial value collection.
`void`	`constructor()` The domain-specific constructor of the Classifier.
`static GUIInput`	`createCombo(GUIContainerComponent parent)` Creates a combo widget that presents objects obtained through the widget binding mechanism via the `collection` input pin (`ipCollection()` method).
`static GUIInput`	`createCombo(GUIContainerComponent parent, IProperty property)` Creates a combo widget that presents objects obtained by reading the slot that corresponds to provided property of the domain object obtained through the widget binding mechanism via the `element` input pin (`ipSlotValueElement()` method).
`static GUIInput`	`createCombo(GUIContainerComponent parent, IProperty property, LayoutData layoutData)` Creates a combo widget that presents objects obtained by reading the slot that corresponds to provided property of the domain object obtained through the widget binding mechanism via the `element` input pin (`ipSlotValueElement()` method), and additionally, sets a specific layout data information.
`static GUIInput`	`createCombo(GUIContainerComponent parent, LayoutData layoutData)` Creates a combo widget that presents objects obtained through the widget binding mechanism via the `collection` input pin (`ipCollection()` method) and sets a specific layout data information.
`static GUIInput`	`createField(GUIContainerComponent parent, IDataType dataType)` Creates a field input control depending on a data type provided.
`static GUIInput`	`createField(GUIContainerComponent parent, IDataType dataType, int row, int column)` Creates a field input control depending on a data type provided and sets the row and column indices for the target cell in a table.
`static GUIInput`	`createField(GUIContainerComponent parent, IDataType dataType, LayoutData layoutData)` Creates a field input control depending on a data type provided and sets a specific layout data information.
`static GUIInput`	`createList(GUIContainerComponent parent)` Creates a list widget that presents objects obtained through the widget binding mechanism via the `collection` input pin (`ipCollection()` method).
`static GUIInput`	`createList(GUIContainerComponent parent, IProperty property)` Creates a list widget that presents objects obtained by reading the slot that corresponds to provided property of the domain object obtained through the widget binding mechanism via the `element` input pin (`ipSlotValueElement()` method).
`static GUIInput`	`createSuggest(GUIContainerComponent parent)` Creates a suggest widget that presents objects obtained through the widget binding mechanism via the `collection` input pin (`ipCollection()` method).
`static GUIInput`	`createSuggest(GUIContainerComponent parent, IProperty property)` Creates a suggest widget that presents objects obtained by reading the slot that corresponds to provided property of the domain object obtained through the widget binding mechanism via the `element` input pin (`ipSlotValueElement()` method).
`static GUIInput`	`createSuggest(GUIContainerComponent parent, IProperty property, LayoutData layoutData)` Creates a suggest widget that presents objects obtained by reading the slot that corresponds to provided property of the domain object obtained through the widget binding mechanism via the `element` input pin (`ipSlotValueElement()` method), and additionally, sets a specific layout data information.
`static GUIInput`	`createSuggest(GUIContainerComponent parent, LayoutData layoutData)` Creates a suggest widget that presents objects obtained through the widget binding mechanism via the `collection` input pin (`ipCollection()` method) and sets a specific layout data information.
`static GUIInput`	`createTable(GUIContainerComponent parent)` Creates a table widget that presents objects obtained through the widget binding mechanism via the `collection` input pin (`ipCollection()` method).
`static GUIInput`	`createTable(GUIContainerComponent parent, IProperty property)` Creates a table widget that presents objects obtained by reading the slot that corresponds to provided property of the domain object obtained through the widget binding mechanism via the `element` input pin (`ipSlotValueElement()` method).
`static GUIInput`	`createTable(GUIContainerComponent parent, IProperty property, java.lang.String... columnLabels)` Creates a table widget that presents objects obtained by reading the slot that corresponds to provided property of the domain object obtained through the widget binding mechanism via the `element` input pin (`ipSlotValueElement()` method), and additionally, sets a column labels in a table header.
`static GUIInput`	`createTable(GUIContainerComponent parent, java.lang.String... columnLabels)` Creates a table widget that presents objects obtained through the widget binding mechanism via the `collection` input pin (`ipCollection()` method) and sets a column labels in the table header.
`static GUIInput`	`createTree(GUIContainerComponent parent)` Creates a tree widget that presents objects obtained through the widget binding mechanism via the `collection` input pin (`ipCollection()` method).
`static GUIInput`	`createTree(GUIContainerComponent parent, IProperty property)` Creates a tree widget that presents objects obtained by reading the slot that corresponds to provided property of the domain object obtained through the widget binding mechanism via the `element` input pin (`ipSlotValueElement()` method).
`java.lang.String`	`getAllowedExtenstions()` Returns allowed extensions.
`boolean`	`getAllowFreeText()` Deprecated. Not supported any more.
`java.lang.String`	`getCheckBoxLabel()` Returns the check box label.
`java.util.List<GUIComponent>`	`getColumnComponents()` Returns the collection of column widgets of this table.
`java.lang.String[]`	`getColumnNames()` Returns the column names `String` array.
`java.lang.String`	`getDefaultTime()` Returns the default time.
`boolean`	`getDisplayDateAsCalendar()` Returns whether this widget (if it is a configured for the `Date` or `DateTime` type) should be displayed as calendar.
`boolean`	`getEmptyTextAsNull()` Returns whether empty text is treated as null or as empty `String` ("").
`boolean`	`getHTML()` Returns whether this widget accepts HTML.
`java.util.List<rs.sol.soloist.server.uml.concepts.IElement>`	`getInitialValues()` Returns the initial values list.
`int`	`getLowerBound()` Returns the lower bound.
`int`	`getMaxLength()` Returns the max length in characters that this widget can accept.
`int`	`getMinRows()` Returns the minimum number of rows always displayed in a table (if this widget is a table at all).
`boolean`	`getMultiline()` Returns whether this widget is displayed as text area.
`boolean`	`getPassword()` Returns whether this widget is displayed as password text box.
`java.lang.String`	`getRegularExpression()` Returns the regular expression.
`int`	`getSelectionLowerBound()` Returns the selection lower bound.
`int`	`getSelectionUpperBound()` Returns the selection upper bound.
`boolean`	`getShowSuggestionsOnFocus()` Returns whether this widget (is it is a suggest widget) should show suggestions on focus.
`boolean`	`getSlotValueIndirect()` Deprecated. Not supported any more.
`java.lang.String`	`getSlotValuePropertyFQName()` Returns the slot value property name.
`GUICommandComponent`	`getTableTransformer()` Returns the table transformer command widget if it exist and if this widget is a table at all.
`boolean`	`getToggle()` Returns whether this widget (if it is configured for the `Boolean` type) should be displayed as toggle button instead of as check box.
`java.lang.String`	`getTypeFQName()` Returns the type FQ name.
`int`	`getUpperBound()` Returns the upper bound.
`ISlot<?>`	`ipChecked()` Returns the `checked` input pin; when event occurs, if this widget is check box, it will get checked.
`ISlot<?>`	`ipClearValue()` Returns the `clearValue` input pin; when event occurs, selected, picked, or specified value of this widget will be cleared.
`ISlot<?>`	`ipCollection()` Returns the `collection` input pin; when event occurs, the collection of instances from the binding message will be presented in this widget.
`ISlot<?>`	`ipFocus()` Returns the `focus` input pin; when event occurs, this widget will receive focus.
`ISlot<?>`	`ipRefreshInput()` Returns the `refresh` input pin; when event occurs, the presented data will be re-fetched from the server.
`ISlot<?>`	`ipReset()` Returns the `reset` input pin; when event occurs the value of this widget will be re-set to initial value.
`ISlot<?>`	`ipSelectAll()` Returns the `selectAll` input pin; when event occurs, this widget will select all objects that are presented at that moment in time.
`ISlot<?>`	`ipSelection()` Returns the `selection` input pin; when event occurs, this widget will try to select object(s) from the binding message if it/they is/are presented in this widget.
`ISlot<?>`	`ipSlotValueElement()` Returns the slot value `element` input pin; when event occurs, the slot value of the object from the binding message will be fetched and and presented.
`ISlot<?>`	`ipSubnodesInput()` Deprecated. Not supported any more.
`ISlot<?>`	`ipUnchecked()` Returns the `unchecked` input pin; when event occurs, if this widget is check box, it will get unchecked.
`ISlot<?>`	`ipUnselectAll()` Returns the `unselectAll` input pin; when event occurs, this widget will un-select all selected objects that are presented at that moment in time.
`ISlot<?>`	`ipValue()` Returns the `value` input pin; when event occurs, binding message content will be presented, picked or selected by this widget.
`ISlot<?>`	`opChecked()` Returns the `checked` output pin; for every check of the value of the check box, an empty binding message will be provided on this pin.
`ISlot<?>`	`opEnterPressed()` Returns the `enterPressed` output pin; when this widget has focus and enter pressed event is issued, the empty binding message will be provided on this pin.
`ISlot<?>`	`opFocus()` Returns the `focus` output pin; when this widget receives focus, the empty binding message will be provided on this pin.
`ISlot<?>`	`opFocusLost()` Returns the `focusLost` output pin; when this widget loses focus, the empty binding message will be provided on this pin.
`ISlot<?>`	`opParent()` Returns the `parent` output pin; for every change of selection in a tree, the binding message with the parent object of the newly selected object will be provided on this pin.
`ISlot<?>`	`opSelection()` Returns the `selection` output pin; for every change of selection the binding message with selected object(s) will be provided on this pin.
`ISlot<?>`	`opUnchecked()` Returns the `unchecked` output pin; for every un-check of the value of the check box, an empty binding message will be provided on this pin.
`ISlot<?>`	`opValue()` Returns the `value` output pin; when the selected, picked, or typed-in value of this widget changes, the binding message with that new value will be provided on this pin.
`void`	`removeColumnComponent(GUIComponent c)` Removes the component from the collection of column components.
`void`	`removeColumnName(java.lang.String name)` Removes the column name of this table.
`void`	`removeInitialValue(rs.sol.soloist.server.uml.concepts.IElement el)` Removes one initial value.
`void`	`setAllowedExtensions(java.lang.String extensions)` Sets the allowable file extensions if this widget is configured with `File` or `Picture` data type.
`void`	`setAllowFreeText(boolean value)` Deprecated. Not supported any more.
`void`	`setCheckBoxLabel(java.lang.String label)` Sets the check box label if this widget is configured with the `Boolean` data type and has lower bound set to 1.
`void`	`setColumnComponents(GUIComponent... components)` Sets the array of new column widgets.
`void`	`setColumnComponents(java.util.List<GUIComponent> components)` Sets the collection of new column widgets.
`void`	`setColumnNames(java.lang.String... names)` Sets the column names of this table.
`void`	`setDefaultTime(java.lang.String defaultTime)` Sets the default display time if this widget is configured with `Time` or `DataTime` data type.
`void`	`setDisplayDateAsCalendar(boolean displayAsCalendar)` Sets whether this widget (if it is a configured for the `Date` or `DateTime` type) should be displayed as calendar.
`void`	`setEmptyTextAsNull(boolean isEmptyTextNull)` Sets whether empty text is treated as null or as empty `String` ("").
`void`	`setHTML(boolean isHTML)` Sets whether this widget should accept HTML text.
`void`	`setInitialValues(java.util.List<rs.sol.soloist.server.uml.concepts.IElement> elements)` Sets the initial values.
`void`	`setLowerBound(int lowerBound)` Sets the lower bound.
`void`	`setMaxLength(int length)` Sets the max acceptable text length.
`void`	`setMinRows(int minRows)` Sets the min number of rows always apparent in the table.
`void`	`setMultiline(boolean isMultiline)` Sets whether this widget appears as text area.
`void`	`setPassword(boolean isPassword)` Sets whether this widget should act as a password text box.
`void`	`setRegularExpression(java.lang.String regex)` Sets the regular expression that drives the validation of this widget.
`void`	`setSelectionLowerBound(int bound)` Sets the selection lower bound if this widget is a list, tree, or a table version.
`void`	`setSelectionUpperBound(int bound)` Sets the selection upper bound if this widget is a list, tree, or a table version.
`void`	`setShowSuggestionsOnFocus(boolean show)` Sets whether this widget should show suggestion immediately after receives focus or wait until at least one character is typed-in.
`void`	`setSlotValueIndirect(boolean value)` Deprecated. Not supported any more.
`void`	`setSlotValuePropertyFQName(java.lang.String fqName)` Sets the property FQ name that determines the slot of the object received via the widget binding mechanism via the slot value `element` input pin (`ipSlotValueElement()` method), which will be used to fetch objects and present them in this widget.
`void`	`setTableTransformer(GUICommandComponent t)` Sets the transformer command widget.
`void`	`setToggle(boolean isToggle)` Sets whether this widget should behave like a toggle button.
`void`	`setTypeFQName(java.lang.String typeFQName)` Sets the FQ name of the data type according to which this widget should work.
`void`	`setUpperBound(int upperBound)` Sets the upper bound.

Methods inherited from class rs.sol.soloist.server.guiconfiguration.elementcomponents.GUIElementComponent
addEnumerationInstancesInfo, create, create, create, create, create, create, create, createInput, createInput, createInput, createInput, createInput, createInput, createInput, createInput, createInputCheckbox, createInputCheckbox, createInputTree, createInputTree, createInputTree, createInputTree, createInputTree, createSlotEditor, createSlotEditor, createSlotEditor, createSlotEditor, createSlotEditor, createSlotEditor, createSlotEditor, createSlotEditor, createSlotEditor, createSlotEditor, createSlotEditor, createSlotEditor, createSlotEditorCheckbox, createSlotEditorCheckbox, createSlotEditorTree, getAutoSubmit, getDisplayAsLabel, getIndirect, getIntegralPart, getMaxFileSize, getPartial, getPropertyFQName, getReadOnly, ipElement, ipParent, ipRefresh, ipSubmit, setAutoSubmit, setDisplayAsLabel, setIndirect, setMaxFileSize, setPartial, setPropertyFQName, setReadOnly, validate

Methods inherited from class rs.sol.soloist.server.guiconfiguration.elementcomponents.GUIElementComponent

addEnumerationInstancesInfo, create, create, create, create, create, create, create, createInput, createInput, createInput, createInput, createInput, createInput, createInput, createInput, createInputCheckbox, createInputCheckbox, createInputTree, createInputTree, createInputTree, createInputTree, createInputTree, createSlotEditor, createSlotEditor, createSlotEditor, createSlotEditor, createSlotEditor, createSlotEditor, createSlotEditor, createSlotEditor, createSlotEditor, createSlotEditor, createSlotEditor, createSlotEditor, createSlotEditorCheckbox, createSlotEditorCheckbox, createSlotEditorTree, getAutoSubmit, getDisplayAsLabel, getIndirect, getIntegralPart, getMaxFileSize, getPartial, getPropertyFQName, getReadOnly, ipElement, ipParent, ipRefresh, ipSubmit, setAutoSubmit, setDisplayAsLabel, setIndirect, setMaxFileSize, setPartial, setPropertyFQName, setReadOnly, validate

Methods inherited from class rs.sol.soloist.server.guiconfiguration.construction.GUIComponent
addStyleNames, addValueToSlot, clearSlot, clone, createInfo, createInfoAlreadyValidated, destructor, fillElementInfo, getApplication, getCommands, getCommands, getCommonOwner, getContext, getDescription, getDescrString, getDragIcon, getEnabled, getFeature, getFeature, getInputBindings, getInputPin, getInputPins, getLabelString, getLargeIcon, getLayoutData, getName, getNameString, getOutputPin, getOutputPins, getOwner, getParts, getSetting, getSmallIcon, getStyle, getSubnodes, getTooltip, getTooltipString, getTypeString, getVisible, handle, ipAddStyle, ipEnabled, ipInit, ipRemoveStyle, ipShow, ipShowInParent, ipVisible, isInputPin, isOutputPin, putFeatureInfo, readElement, readElements, readSlot, readSlotAsInfo, readSubnodes, removeValueFromSlot, setCellAlignment, setCellSize, setCellStyle, setCenter, setContext, setDescription, setDirectionAndSize, setEnabled, setLayoutData, setLeftRightWidth, setName, setRowColumn, setRowColumn, setSize, setSlot, setSlot, setStyle, setTooltip, setTopBottomHeight, setVisible, setXY, toTranslateDescriptors, translatePinName, updateInfo, validateParts, validateParts

Methods inherited from class rs.sol.soloist.server.guiconfiguration.construction.GUIComponent

addStyleNames, addValueToSlot, clearSlot, clone, createInfo, createInfoAlreadyValidated, destructor, fillElementInfo, getApplication, getCommands, getCommands, getCommonOwner, getContext, getDescription, getDescrString, getDragIcon, getEnabled, getFeature, getFeature, getInputBindings, getInputPin, getInputPins, getLabelString, getLargeIcon, getLayoutData, getName, getNameString, getOutputPin, getOutputPins, getOwner, getParts, getSetting, getSmallIcon, getStyle, getSubnodes, getTooltip, getTooltipString, getTypeString, getVisible, handle, ipAddStyle, ipEnabled, ipInit, ipRemoveStyle, ipShow, ipShowInParent, ipVisible, isInputPin, isOutputPin, putFeatureInfo, readElement, readElements, readSlot, readSlotAsInfo, readSubnodes, removeValueFromSlot, setCellAlignment, setCellSize, setCellStyle, setCenter, setContext, setDescription, setDirectionAndSize, setEnabled, setLayoutData, setLeftRightWidth, setName, setRowColumn, setRowColumn, setSize, setSlot, setSlot, setStyle, setTooltip, setTopBottomHeight, setVisible, setXY, toTranslateDescriptors, translatePinName, updateInfo, validateParts, validateParts

Methods inherited from class rs.sol.soloist.server.javaimpl.runtime.SOLoistClassInstance
`destroy, equals, getAssociationEndInstance, getAssociationEndInstances, getAttributeValue, getAttributeValues, getMyClass, getMyID, getSlot, getSlot, getSlots, getUMLClass, hashCode, isMarkedAsDeleted, toString`

Methods inherited from class rs.sol.soloist.server.uml.commonimplementation.runtime._ClassInstance
`accept, accept, exists, getAssociationEndInstance, getAssociationEndInstance, getAssociationEndInstance, getClassifier, hasIdentity, isClassInstance, isDataTypeInstance, isEqualTo, makeClone, markAsDeleted`

Methods inherited from class rs.sol.soloist.server.uml.commonimplementation.runtime._ClassifierInstance
`conformsTo, copySlots, copySlots, getAttributeValue, getAttributeValue, getAttributeValue, getClassifierFQName, getClassifierUQName, getFirstCommonGeneralizer, getFirstCommonGeneralizerFQName, getFirstCommonGeneralizerUQName, getMElement, getSlot, getSlot, isDirectInstanceOf, isDirectInstanceOf, isInstanceOf, isInstanceOf, isKindOf, isModelElement, isRTElement`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Methods inherited from interface rs.sol.soloist.server.uml.concepts.runtime.IClassifierInstance
`conformsTo, copySlots, copySlots, getAttributeValue, getAttributeValue, getClassifierFQName, getClassifierUQName, getFirstCommonGeneralizer, getFirstCommonGeneralizerFQName, getFirstCommonGeneralizerUQName, getSlot, getSlot, isDirectInstanceOf, isDirectInstanceOf, isInstanceOf, isInstanceOf`

Methods inherited from interface rs.sol.soloist.server.uml.concepts.runtime.IRTElement
`getMElement`

Methods inherited from interface rs.sol.soloist.server.uml.concepts.IElement
`isKindOf, isModelElement, isRTElement`

Field Detail

FQ_TYPE_NAME

public static final java.lang.String FQ_TYPE_NAME

Fully qualified UML class name

See Also:: Constant Field Values

CLASSIFIER

public static final IClass CLASSIFIER

UML class reference

Constructor Detail

GUIInput

public GUIInput()

Method Detail

constructor

public void constructor()

Description copied from interface: IClassifierInstance

The domain-specific constructor of the Classifier.

Specified by:: constructor in interface IClassifierInstance
Overrides:: constructor in class GUIElementComponent

createField

public static GUIInput createField(GUIContainerComponent parent,
                                   IDataType dataType)

Creates a field input control depending on a data type provided.

For example:

If the data type is Boolean then a combo box with three options (empty option, true, and false) is created. To make it appear as check box, the lower multiplicity must be set to 1 using setLowerBound(int) method. The lower (multiplicity) bound means that it is not acceptable not to pick any value.
If the data type is one of these: Text, Integer, Real, Time, TimeInterval then a text box is created with an appropriate basic validation rules.
If the data type is Date or DateTime then a text box and a date(time) picker are created.

Code examples:

 GUIInput input = GUIInput.create(parent, Text.CLASSIFIER); // regular text box
 input.setMultiline(true); // this will make it appear as a text area
 input.setRegularExpression("^\\(?(\\d{3})\\)?[- ]?(\\d{3})[- ]?(\\d{4})$"); // this will add a phone number validation constraint
 
 GUIInput input = GUIInput.create(parent, Integer.CLASSIFIER); // text box that accepts valid integers
 
 GUIInput input = GUIInput.create(parent, Real.CLASSIFIER); // text box that accepts valid doubles
 
 GUIInput input = GUIInput.create(parent, Boolean.CLASSIFIER); // combo box with empty, true and false values
 input.setLowerBound(1); // this will make it appear as check box
 input.addInitialValue(Boolean.TRUE); // this will set the true initial value
 input.setCheckBoxLabel("Is married?"); // this will add a label
 input.setToggle(true); // this will make the check box appear as a toggle button
 
 GUIInput input = GUIInput.create(parent, Date.CLASSIFIER); // text box and a date picker

Parameters:: parent - the parent GUIContainerComponent widget; dataType - the data type whose values should be supported
Returns:: the created GUIInput widget

createField

public static GUIInput createField(GUIContainerComponent parent,
                                   IDataType dataType,
                                   LayoutData layoutData)

Creates a field input control depending on a data type provided and sets a specific layout data information. Acts the same way as createField(GUIContainerComponent, IDataType) method, plus adds layout specification.

Parameters:: parent - the parent GUIContainerComponent widget; dataType - the data type whose values should be supported; layoutData - the LayoutData of the widget to be created
Returns:: the created GUIInput widget

createField

public static GUIInput createField(GUIContainerComponent parent,
                                   IDataType dataType,
                                   int row,
                                   int column)

Creates a field input control depending on a data type provided and sets the row and column indices for the target cell in a table. Acts the same way as createField(GUIContainerComponent, IDataType, LayoutData) method, but constrained to table layout.

Parameters:: parent - the parent GUIContainerComponent widget; dataType - the data type whose values should be supported; row - the row index in a parent table of the widget to be created; column - the column index in a parent table of the widget to be created
Returns:: the created GUIInput widget

createList

public static GUIInput createList(GUIContainerComponent parent)

Creates a list widget that presents objects obtained through the widget binding mechanism via the collection input pin (ipCollection() method).

Parameters:: parent - the parent GUIContainerComponent widget
Returns:: the created list

createList

public static GUIInput createList(GUIContainerComponent parent,
                                  IProperty property)

Creates a list widget that presents objects obtained by reading the slot that corresponds to provided property of the domain object obtained through the widget binding mechanism via the element input pin (ipSlotValueElement() method).

Parameters:: parent - the parent GUIContainerComponent widget; property - the property whose slot is to be read
Returns:: the created list

createTree

public static GUIInput createTree(GUIContainerComponent parent)

Creates a tree widget that presents objects obtained through the widget binding mechanism via the collection input pin (ipCollection() method).

Parameters:: parent - the parent GUIContainerComponent widget
Returns:: the created tree

createTree

public static GUIInput createTree(GUIContainerComponent parent,
                                  IProperty property)

Creates a tree widget that presents objects obtained by reading the slot that corresponds to provided property of the domain object obtained through the widget binding mechanism via the element input pin (ipSlotValueElement() method).

Parameters:: parent - the parent GUIContainerComponent widget; property - the property whose slot is to be read
Returns:: the created tree

createCombo

public static GUIInput createCombo(GUIContainerComponent parent)

Creates a combo widget that presents objects obtained through the widget binding mechanism via the collection input pin (ipCollection() method).

Parameters:: parent - the parent GUIContainerComponent widget
Returns:: the created combo

createCombo

public static GUIInput createCombo(GUIContainerComponent parent,
                                   LayoutData layoutData)

Creates a combo widget that presents objects obtained through the widget binding mechanism via the collection input pin (ipCollection() method) and sets a specific layout data information.

Parameters:: parent - the parent GUIContainerComponent widget; layoutData - the LayoutData of the widget to be created
Returns:: the created combo

createCombo

public static GUIInput createCombo(GUIContainerComponent parent,
                                   IProperty property)

Creates a combo widget that presents objects obtained by reading the slot that corresponds to provided property of the domain object obtained through the widget binding mechanism via the element input pin (ipSlotValueElement() method).

Parameters:: parent - the parent GUIContainerComponent widget; property - the property whose slot is to be read
Returns:: the created combo

createCombo

public static GUIInput createCombo(GUIContainerComponent parent,
                                   IProperty property,
                                   LayoutData layoutData)

Parameters:: parent - the parent GUIContainerComponent widget; property - the property whose slot is to be read; layoutData - the LayoutData of the widget to be created
Returns:: the created combo

createSuggest

public static GUIInput createSuggest(GUIContainerComponent parent)

Creates a suggest widget that presents objects obtained through the widget binding mechanism via the collection input pin (ipCollection() method).

Parameters:: parent - the parent GUIContainerComponent widget
Returns:: the created suggest

createSuggest

public static GUIInput createSuggest(GUIContainerComponent parent,
                                     LayoutData layoutData)

Creates a suggest widget that presents objects obtained through the widget binding mechanism via the collection input pin (ipCollection() method) and sets a specific layout data information.

Parameters:: parent - the parent GUIContainerComponent widget; layoutData - the LayoutData of the widget to be created
Returns:: the created suggest

createSuggest

public static GUIInput createSuggest(GUIContainerComponent parent,
                                     IProperty property)

Creates a suggest widget that presents objects obtained by reading the slot that corresponds to provided property of the domain object obtained through the widget binding mechanism via the element input pin (ipSlotValueElement() method).

Parameters:: parent - the parent GUIContainerComponent widget; property - the property whose slot is to be read
Returns:: the created suggest widget

createSuggest

public static GUIInput createSuggest(GUIContainerComponent parent,
                                     IProperty property,
                                     LayoutData layoutData)

Parameters:: parent - the parent GUIContainerComponent widget; property - the property whose slot is to be read; layoutData - the LayoutData of the widget to be created
Returns:: the created suggest widget

createTable

public static GUIInput createTable(GUIContainerComponent parent)

Creates a table widget that presents objects obtained through the widget binding mechanism via the collection input pin (ipCollection() method).

Parameters:: parent - the parent GUIContainerComponent widget
Returns:: the created table

createTable

public static GUIInput createTable(GUIContainerComponent parent,
                                   java.lang.String... columnLabels)

Creates a table widget that presents objects obtained through the widget binding mechanism via the collection input pin (ipCollection() method) and sets a column labels in the table header.

Parameters:: parent - the parent GUIContainerComponent widget; columnLabels - the array of column labels to be placed in a table header
Returns:: the created table

createTable

public static GUIInput createTable(GUIContainerComponent parent,
                                   IProperty property)

Creates a table widget that presents objects obtained by reading the slot that corresponds to provided property of the domain object obtained through the widget binding mechanism via the element input pin (ipSlotValueElement() method).

Parameters:: parent - the parent GUIContainerComponent widget; property - the property whose slot is to be read
Returns:: the created table

createTable

public static GUIInput createTable(GUIContainerComponent parent,
                                   IProperty property,
                                   java.lang.String... columnLabels)

Parameters:: parent - the parent GUIContainerComponent widget; property - the property whose slot is to be read; columnLabels - the array of column labels to be placed in a table header
Returns:: the created table

ipValue

public ISlot<?> ipValue()

Returns the value input pin; when event occurs, binding message content will be presented, picked or selected by this widget.

For example, if this widget is a list, and a binding message with the object (contained in the list) is received through this pin, the object will immediately become selected. Or, if this widget is a text box, then each binding message with a text received through this pin will set the text box to that new value (the old value will be cleared).

Overrides:: ipValue in class GUIElementComponent

Returns:: the value input pin
See Also:: GUIComponentBinding

ipClearValue

public ISlot<?> ipClearValue()

Returns the clearValue input pin; when event occurs, selected, picked, or specified value of this widget will be cleared. The binding message content is of no importance. Only event is what matters.

For example, if this widget is a list, this will clear the selection. If this widget is a text box, it will clear the text in the text box.

Overrides:: ipClearValue in class GUIElementComponent

Returns:: the clearValue input pin
See Also:: GUIComponentBinding

ipReset

public ISlot<?> ipReset()

Returns the reset input pin; when event occurs the value of this widget will be re-set to initial value. The binding message content is of no importance. Only event is what matters.

Overrides:: ipReset in class GUIElementComponent

Returns:: the reset input pin
See Also:: addInitialValue(IElement), GUIComponentBinding

ipRefreshInput

public ISlot<?> ipRefreshInput()

Returns the refresh input pin; when event occurs, the presented data will be re-fetched from the server. The binding message content is of no importance. Only event is what matters. This pin is not supported in the field versions of this widget.

Overrides:: ipRefreshInput in class GUIElementComponent

Returns:: the refresh input pin
See Also:: GUIComponentBinding

ipSubnodesInput

@Deprecated
public ISlot<?> ipSubnodesInput()

Deprecated. Not supported any more.

Overrides:: ipSubnodesInput in class GUIElementComponent

ipCollection

public ISlot<?> ipCollection()

Returns the collection input pin; when event occurs, the collection of instances from the binding message will be presented in this widget. This pin is not supported in the field versions of this widget.

For example, if this widget is a list and receives a collection of domain object instances via this pin, these instances will be presented.

Overrides:: ipCollection in class GUIElementComponent

Returns:: the collection input pin
See Also:: GUIComponentBinding

ipSlotValueElement

public ISlot<?> ipSlotValueElement()

Returns the slot value element input pin; when event occurs, the slot value of the object from the binding message will be fetched and and presented. The slot value is actually a collection of objects linked to the object from the binding message. The property of the slot must be defined during the construction of this widget.

Overrides:: ipSlotValueElement in class GUIElementComponent

Returns:: the slot value element input pin
See Also:: GUIComponentBinding

ipFocus

public ISlot<?> ipFocus()

Returns the focus input pin; when event occurs, this widget will receive focus. The binding message content is of no importance. Only event is what matters. This pin is supported only in field versions of this widget.

Overrides:: ipFocus in class GUIElementComponent

Returns:: the focus input pin
See Also:: GUIComponentBinding

ipChecked

public ISlot<?> ipChecked()

Returns the checked input pin; when event occurs, if this widget is check box, it will get checked. The binding message content is of no importance. This pin is supported only in field version of this widget configured for Boolean data type.

Overrides:: ipChecked in class GUIElementComponent

Returns:: the checked input pin
See Also:: GUIComponentBinding

ipUnchecked

public ISlot<?> ipUnchecked()

Returns the unchecked input pin; when event occurs, if this widget is check box, it will get unchecked. The binding message content is of no importance. Only event is what matters. This pin is supported only in field version of this widget configured for Boolean data type.

Overrides:: ipUnchecked in class GUIElementComponent

Returns:: the unchecked input pin
See Also:: GUIComponentBinding

ipSelection

public ISlot<?> ipSelection()

Returns the selection input pin; when event occurs, this widget will try to select object(s) from the binding message if it/they is/are presented in this widget. This pin is supported only in tree, list, and table versions of this widget.

Overrides:: ipSelection in class GUIElementComponent

Returns:: the selection input pin
See Also:: GUIComponentBinding

ipSelectAll

public ISlot<?> ipSelectAll()

Returns the selectAll input pin; when event occurs, this widget will select all objects that are presented at that moment in time. The binding message content is of no importance. Only event is what matters. This pin is supported only in tree, list, and table versions of this widget.

Overrides:: ipSelectAll in class GUIElementComponent

Returns:: the selectAll input pin
See Also:: GUIComponentBinding

ipUnselectAll

public ISlot<?> ipUnselectAll()

Returns the unselectAll input pin; when event occurs, this widget will un-select all selected objects that are presented at that moment in time. The binding message content is of no importance. Only event is what matters. This pin is supported only in tree, list, and table versions of this widget.

Overrides:: ipUnselectAll in class GUIElementComponent

Returns:: the unselectAll input pin
See Also:: GUIComponentBinding

opParent

public ISlot<?> opParent()

Returns the parent output pin; for every change of selection in a tree, the binding message with the parent object of the newly selected object will be provided on this pin. This pin is supported only in tree version of this widget.

Returns:: the parent output pin
See Also:: GUIComponentBinding

opSelection

public ISlot<?> opSelection()

Returns the selection output pin; for every change of selection the binding message with selected object(s) will be provided on this pin. This pin is supported only in tree, list, and table versions of this widget.

Overrides:: opSelection in class GUIElementComponent

Returns:: the selection output pin
See Also:: GUIComponentBinding

opUnchecked

public ISlot<?> opUnchecked()

Returns the unchecked output pin; for every un-check of the value of the check box, an empty binding message will be provided on this pin. This pin is only supported in the field version of this widget configured for Boolean data type.

Overrides:: opUnchecked in class GUIElementComponent

Returns:: the unchecked output pin
See Also:: GUIComponentBinding

opChecked

public ISlot<?> opChecked()

Returns the checked output pin; for every check of the value of the check box, an empty binding message will be provided on this pin. This pin is only supported in the field version of this widget configured for Boolean data type.

Overrides:: opChecked in class GUIElementComponent

Returns:: the checked output pin
See Also:: GUIComponentBinding

opFocus

public ISlot<?> opFocus()

Returns the focus output pin; when this widget receives focus, the empty binding message will be provided on this pin. This pin is only supported in field versions of this widget.

Overrides:: opFocus in class GUIElementComponent

Returns:: the focus output pin
See Also:: GUIComponentBinding

opFocusLost

public ISlot<?> opFocusLost()

Returns the focusLost output pin; when this widget loses focus, the empty binding message will be provided on this pin. This pin is only supported in field versions of this widget.

Overrides:: opFocusLost in class GUIElementComponent

Returns:: the focusLost output pin
See Also:: GUIComponentBinding

opEnterPressed

public ISlot<?> opEnterPressed()

Returns the enterPressed output pin; when this widget has focus and enter pressed event is issued, the empty binding message will be provided on this pin. This pin is only supported in field versions of this widget.

Overrides:: opEnterPressed in class GUIElementComponent

Returns:: the enterPressed output pin
See Also:: GUIComponentBinding

opValue

public ISlot<?> opValue()

Returns the value output pin; when the selected, picked, or typed-in value of this widget changes, the binding message with that new value will be provided on this pin.

Overrides:: opValue in class GUIElementComponent

Returns:: the value output pin
See Also:: GUIComponentBinding

getLowerBound

public int getLowerBound()

Returns the lower bound.

Overrides:: getLowerBound in class GUIElementComponent

Returns:: the lower bound
See Also:: setLowerBound(int)

setLowerBound

public void setLowerBound(int lowerBound)

Sets the lower bound. The upper and lower bounds define how many values this widget can accept. If the lower bound is 0, then selecting no value is acceptable. This is not case if the lower bound is 1, in which case at least one value must always be selected or picked in this widget.

For example, the combo box with lower bound 0 would present an empty option in the list options. The same combo box with lower bound 1 would not present it however. The list of objects with lower bound 0, would allow not selecting any objects, but if the lower bound is 1, then at least one object must always be selected in the list.

Overrides:: setLowerBound in class GUIElementComponent

Parameters:: lowerBound - the new lower bound. Default is 0.
See Also:: setUpperBound(int)

getUpperBound

public int getUpperBound()

Returns the upper bound.

Overrides:: getUpperBound in class GUIElementComponent

Returns:: the upper bound
See Also:: setUpperBound(int)

setUpperBound

public void setUpperBound(int upperBound)

Sets the upper bound. The upper and lower bounds define how many values this widget can accept. If the upper bound is 1, then only one value can be selected or picked in this widget. This method should not be called for field, combo, and suggest version of this widget; only for list, tree, and table versions.

For example, if the list of objects has upper bound 1 then only one object can be selected at the time.

Overrides:: setUpperBound in class GUIElementComponent

Parameters:: upperBound - the new upper bound. Default is 1. Infinitely is -1.
See Also:: setLowerBound(int)

getSlotValuePropertyFQName

public java.lang.String getSlotValuePropertyFQName()

Returns the slot value property name.

Overrides:: getSlotValuePropertyFQName in class GUIElementComponent

Returns:: the slot value property name
See Also:: setSlotValuePropertyFQName(String)

setSlotValuePropertyFQName

public void setSlotValuePropertyFQName(java.lang.String fqName)

Sets the property FQ name that determines the slot of the object received via the widget binding mechanism via the slot value element input pin (ipSlotValueElement() method), which will be used to fetch objects and present them in this widget. This method should not be called for field version of this widget; only for list, tree, combo, suggest, and table versions.

Overrides:: setSlotValuePropertyFQName in class GUIElementComponent

Parameters:: fqName - the FQ name of the slot

getSlotValueIndirect

@Deprecated
public boolean getSlotValueIndirect()

Deprecated. Not supported any more.

Overrides:: getSlotValueIndirect in class GUIElementComponent

setSlotValueIndirect

@Deprecated
public void setSlotValueIndirect(boolean value)

Deprecated. Not supported any more.

Overrides:: setSlotValueIndirect in class GUIElementComponent

getTypeFQName

public java.lang.String getTypeFQName()

Returns the type FQ name.

Overrides:: getTypeFQName in class GUIElementComponent

Returns:: the type FQ name
See Also:: setTypeFQName(String)

setTypeFQName

public void setTypeFQName(java.lang.String typeFQName)

Sets the FQ name of the data type according to which this widget should work.

For example, if this method is called with Text.FQ_TYPE_NAME as a parameter, then this widget will appear as a text box for accepting text values.

Overrides:: setTypeFQName in class GUIElementComponent

Parameters:: typeFQName - the data type FQ name

getCheckBoxLabel

public java.lang.String getCheckBoxLabel()

Returns the check box label.

Overrides:: getCheckBoxLabel in class GUIElementComponent

Returns:: the check box label
See Also:: setCheckBoxLabel(String)

setCheckBoxLabel

public void setCheckBoxLabel(java.lang.String label)

Sets the check box label if this widget is configured with the Boolean data type and has lower bound set to 1.

Overrides:: setCheckBoxLabel in class GUIElementComponent

Parameters:: label - the new check box label

getDefaultTime

public java.lang.String getDefaultTime()

Returns the default time.

Overrides:: getDefaultTime in class GUIElementComponent

Returns:: the default time
See Also:: setDefaultTime(String)

setDefaultTime

public void setDefaultTime(java.lang.String defaultTime)

Sets the default display time if this widget is configured with Time or DataTime data type.

Overrides:: setDefaultTime in class GUIElementComponent

Parameters:: defaultTime - the default time. Default is 12:00.

getAllowedExtenstions

public java.lang.String getAllowedExtenstions()

Returns allowed extensions.

Overrides:: getAllowedExtenstions in class GUIElementComponent

Returns:: the allowed extensions
See Also:: setAllowedExtensions(String)

setAllowedExtensions

public void setAllowedExtensions(java.lang.String extensions)

Sets the allowable file extensions if this widget is configured with File or Picture data type.

Overrides:: setAllowedExtensions in class GUIElementComponent

Parameters:: extensions - the allowable file extensions

getRegularExpression

public java.lang.String getRegularExpression()

Returns the regular expression.

Overrides:: getRegularExpression in class GUIElementComponent

Returns:: the regular expression
See Also:: setRegularExpression(String)

setRegularExpression

public void setRegularExpression(java.lang.String regex)

Sets the regular expression that drives the validation of this widget. It is supported only in the field versions of this widget.

Overrides:: setRegularExpression in class GUIElementComponent

Parameters:: regex - the regular expression that drives the validation

getMultiline

public boolean getMultiline()

Returns whether this widget is displayed as text area.

Overrides:: getMultiline in class GUIElementComponent

Returns:: whether this widget is displayed as text area
See Also:: setMultiline(boolean)

setMultiline

public void setMultiline(boolean isMultiline)

Sets whether this widget appears as text area. This is relevant only if this widget is configured with Text data type.

Overrides:: setMultiline in class GUIElementComponent

Parameters:: isMultiline - the boolean that tells whether this widget appears as text area

getPassword

public boolean getPassword()

Returns whether this widget is displayed as password text box.

Overrides:: getPassword in class GUIElementComponent

Returns:: whether this widget is displayed as password text box
See Also:: setPassword(boolean)

setPassword

public void setPassword(boolean isPassword)

Sets whether this widget should act as a password text box.

Overrides:: setPassword in class GUIElementComponent

Parameters:: isPassword - the boolean that tells whether this widget should act as a password text box

getEmptyTextAsNull

public boolean getEmptyTextAsNull()

Returns whether empty text is treated as null or as empty String ("").

Overrides:: getEmptyTextAsNull in class GUIElementComponent

Returns:: whether empty text is treated as null or as empty String ("")
See Also:: setEmptyTextAsNull(boolean)

setEmptyTextAsNull

public void setEmptyTextAsNull(boolean isEmptyTextNull)

Sets whether empty text is treated as null or as empty String (""). Relevant only in the field version of this widget configured with Text data type.

Overrides:: setEmptyTextAsNull in class GUIElementComponent

Parameters:: isEmptyTextNull - the boolean that tells whether empty text is treated as null or as empty String ("")

getDisplayDateAsCalendar

public boolean getDisplayDateAsCalendar()

Returns whether this widget (if it is a configured for the Date or DateTime type) should be displayed as calendar.

Overrides:: getDisplayDateAsCalendar in class GUIElementComponent

Returns:: whether this widget should be displayed as calendar
See Also:: setDisplayDateAsCalendar(boolean)

setDisplayDateAsCalendar

public void setDisplayDateAsCalendar(boolean displayAsCalendar)

Sets whether this widget (if it is a configured for the Date or DateTime type) should be displayed as calendar.

Overrides:: setDisplayDateAsCalendar in class GUIElementComponent

Parameters:: displayAsCalendar - the boolean that tells whether this widget should be displayed as calendar

getHTML

public boolean getHTML()

Returns whether this widget accepts HTML.

Overrides:: getHTML in class GUIElementComponent

Returns:: whether this widget accepts HTML
See Also:: setHTML(boolean)

setHTML

public void setHTML(boolean isHTML)

Sets whether this widget should accept HTML text. This is relevant only if this widget is a field version configured with Text data type.

Overrides:: setHTML in class GUIElementComponent

Parameters:: isHTML - the boolean that tells whether this widget should accept HTML text

getMaxLength

public int getMaxLength()

Returns the max length in characters that this widget can accept.

Overrides:: getMaxLength in class GUIElementComponent

Returns:: the max length in characters that this widget can accept
See Also:: setMaxLength(int)

setMaxLength

public void setMaxLength(int length)

Sets the max acceptable text length. This is relevant only if this widget is a field version.

Overrides:: setMaxLength in class GUIElementComponent

Parameters:: length - the max acceptable text length

getSelectionLowerBound

public int getSelectionLowerBound()

Returns the selection lower bound.

Overrides:: getSelectionLowerBound in class GUIElementComponent

Returns:: the selection lower bound
See Also:: setSelectionLowerBound(int)

setSelectionLowerBound

public void setSelectionLowerBound(int bound)

Sets the selection lower bound if this widget is a list, tree, or a table version.

Overrides:: setSelectionLowerBound in class GUIElementComponent

Parameters:: bound - the selection lower bound

getSelectionUpperBound

public int getSelectionUpperBound()

Returns the selection upper bound.

Overrides:: getSelectionUpperBound in class GUIElementComponent

Returns:: the selection upper bound
See Also:: setSelectionUpperBound(int)

setSelectionUpperBound

public void setSelectionUpperBound(int bound)

Sets the selection upper bound if this widget is a list, tree, or a table version.

Overrides:: setSelectionUpperBound in class GUIElementComponent

Parameters:: bound - the selection upper bound

getToggle

public boolean getToggle()

Returns whether this widget (if it is configured for the Boolean type) should be displayed as toggle button instead of as check box.

Overrides:: getToggle in class GUIElementComponent

Returns:: whether this widget should be displayed as toggle button instead of as check box
See Also:: setToggle(boolean)

setToggle

public void setToggle(boolean isToggle)

Sets whether this widget should behave like a toggle button. This is relevant only if this is a field widget version configured with Boolean data type.

Overrides:: setToggle in class GUIElementComponent

Parameters:: isToggle - the boolean that tell whether this widget should behave like the toggle button

getAllowFreeText

@Deprecated
public boolean getAllowFreeText()

Deprecated. Not supported any more.

Overrides:: getAllowFreeText in class GUIElementComponent

setAllowFreeText

@Deprecated
public void setAllowFreeText(boolean value)

Deprecated. Not supported any more.

Overrides:: setAllowFreeText in class GUIElementComponent

getShowSuggestionsOnFocus

public boolean getShowSuggestionsOnFocus()

Returns whether this widget (is it is a suggest widget) should show suggestions on focus.

Overrides:: getShowSuggestionsOnFocus in class GUIElementComponent

Returns:: whether this widget should show suggestions on focus
See Also:: setShowSuggestionsOnFocus(boolean)

setShowSuggestionsOnFocus

public void setShowSuggestionsOnFocus(boolean show)

Sets whether this widget should show suggestion immediately after receives focus or wait until at least one character is typed-in. This is relevant only if this widget is a suggest version.

Overrides:: setShowSuggestionsOnFocus in class GUIElementComponent

Parameters:: show - the boolean that tells whether this widget should show suggestion immediately after receives focus or wait until at least one character is typed-in

getMinRows

public int getMinRows()

Returns the minimum number of rows always displayed in a table (if this widget is a table at all).

Overrides:: getMinRows in class GUIElementComponent

Returns:: the minimum number of rows always displayed in a table
See Also:: setMinRows(int)

setMinRows

public void setMinRows(int minRows)

Sets the min number of rows always apparent in the table. This is relevant only if this widget is the table version.

Overrides:: setMinRows in class GUIElementComponent

Parameters:: minRows - the number of rows always apparent in the table

getTableTransformer

public GUICommandComponent getTableTransformer()

Returns the table transformer command widget if it exist and if this widget is a table at all.

Overrides:: getTableTransformer in class GUIElementComponent

Returns:: the table transformer command widget
See Also:: setTableTransformer(GUICommandComponent), GUICommandComponent

setTableTransformer

public void setTableTransformer(GUICommandComponent t)

Sets the transformer command widget.

Overrides:: setTableTransformer in class GUIElementComponent

Parameters:: t - the transformer command widget
See Also:: GUICommandComponent

getColumnNames

public java.lang.String[] getColumnNames()

Returns the column names String array. This is relevant only if this widget is a table.

Overrides:: getColumnNames in class GUIElementComponent

Returns:: the column names array

setColumnNames

public void setColumnNames(java.lang.String... names)

Sets the column names of this table.

Overrides:: setColumnNames in class GUIElementComponent

Parameters:: names - the column names of this table

addColumnName

public void addColumnName(java.lang.String name)

Adds the column name of this table.

Overrides:: addColumnName in class GUIElementComponent

Parameters:: name - the column name to be added

removeColumnName

public void removeColumnName(java.lang.String name)

Removes the column name of this table.

Overrides:: removeColumnName in class GUIElementComponent

Parameters:: name - the column name to be removed

clearColumnNames

public void clearColumnNames()

Clears the column names of this table.

Overrides:: clearColumnNames in class GUIElementComponent

getInitialValues

public java.util.List<rs.sol.soloist.server.uml.concepts.IElement> getInitialValues()

Returns the initial values list.

Overrides:: getInitialValues in class GUIElementComponent

Returns:: the initial values list

setInitialValues

public void setInitialValues(java.util.List<rs.sol.soloist.server.uml.concepts.IElement> elements)

Sets the initial values.

Overrides:: setInitialValues in class GUIElementComponent

Parameters:: elements - the new list of initial values

addInitialValue

public void addInitialValue(rs.sol.soloist.server.uml.concepts.IElement el)

Adds the new initial value.

Overrides:: addInitialValue in class GUIElementComponent

Parameters:: el - the new initial value to be added

removeInitialValue

public void removeInitialValue(rs.sol.soloist.server.uml.concepts.IElement el)

Removes one initial value.

Overrides:: removeInitialValue in class GUIElementComponent

Parameters:: el - the initial value to be removed

clearInitialValues

public void clearInitialValues()

Clears the initial value collection.

Overrides:: clearInitialValues in class GUIElementComponent

getColumnComponents

public java.util.List<GUIComponent> getColumnComponents()

Returns the collection of column widgets of this table. Of course, this is relevant only if this widget is a table.

Overrides:: getColumnComponents in class GUIElementComponent

Returns:: the list of column components. Does not return null, but empty list instead.

setColumnComponents

public void setColumnComponents(java.util.List<GUIComponent> components)

Sets the collection of new column widgets. This is relevant only if this is the table widget.

Overrides:: setColumnComponents in class GUIElementComponent

Parameters:: components - the collection of new column components

setColumnComponents

public void setColumnComponents(GUIComponent... components)

Sets the array of new column widgets. This is relevant only if this is the table widget.

Overrides:: setColumnComponents in class GUIElementComponent

Parameters:: components - the array of new column components

addColumnComponent

public void addColumnComponent(GUIComponent c)

Adds the new component to the collection of column components. This is relevant only if this widget is a table.

Overrides:: addColumnComponent in class GUIElementComponent

Parameters:: c - the new component (widget) to be added

removeColumnComponent

public void removeColumnComponent(GUIComponent c)

Removes the component from the collection of column components. This is relevant only if this widget is a table.

Overrides:: removeColumnComponent in class GUIElementComponent

Parameters:: c - the component (widget) to be removed

clearColumnComponents

public void clearColumnComponents()

Clears the column components collection.

Overrides:: clearColumnComponents in class GUIElementComponent

addColumn

public void addColumn(java.lang.String name,
                      GUIComponent c)

Adds the column header name and the corresponding column component.

Overrides:: addColumn in class GUIElementComponent

Parameters:: name - the column header name; c - the column component

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

rs.sol.soloist.server.guiconfiguration.elementcomponents Class GUIInput

FQ_TYPE_NAME

CLASSIFIER

GUIInput

constructor

createField

createField

createField

createList

createList

createTree

createTree

createCombo

createCombo

createCombo

createCombo

createSuggest

createSuggest

createSuggest

createSuggest

createTable

createTable

createTable

createTable

ipValue

ipClearValue

ipReset

ipRefreshInput

ipSubnodesInput

ipCollection

ipSlotValueElement

ipFocus

ipChecked

ipUnchecked

ipSelection

ipSelectAll

ipUnselectAll

opParent

opSelection

opUnchecked

opChecked

opFocus

opFocusLost

opEnterPressed

opValue

getLowerBound

setLowerBound

getUpperBound

setUpperBound

getSlotValuePropertyFQName

setSlotValuePropertyFQName

getSlotValueIndirect

setSlotValueIndirect

getTypeFQName

setTypeFQName

getCheckBoxLabel

setCheckBoxLabel

getDefaultTime

setDefaultTime

getAllowedExtenstions

setAllowedExtensions

getRegularExpression

setRegularExpression

getMultiline

setMultiline

getPassword

setPassword

getEmptyTextAsNull

setEmptyTextAsNull

getDisplayDateAsCalendar

setDisplayDateAsCalendar

getHTML

setHTML

getMaxLength

setMaxLength

getSelectionLowerBound

setSelectionLowerBound

getSelectionUpperBound

setSelectionUpperBound

getToggle

rs.sol.soloist.server.guiconfiguration.elementcomponents
Class GUIInput