| Modifier and Type | Method and Description |
|---|---|
String |
AttributeDefinition.getAdditionalDisplayAttributeName() |
boolean |
DocumentEntry.getAllowsCopy() |
boolean |
MaintenanceDocumentEntry.getAllowsNewOrCopy()
Gets the allowsNewOrCopy attribute.
|
boolean |
DocumentEntry.getAllowsNoteAttachments()
Indicates that a document screen allows notes with attachments
|
boolean |
DocumentEntry.getAllowsNoteFYI()
Indicates whether to render the AdHoc FYI recipient box and Send FYI button
|
boolean |
MaintenanceDocumentEntry.getAllowsRecordDeletion() |
String |
AttributeDefinition.getAlternateDisplayAttributeName() |
Class<? extends KeyValuesFinder> |
DocumentEntry.getAttachmentTypesValuesFinderClass() |
String |
SearchingAttribute.getAttributeName() |
String |
ReferenceDefinition.getAttributeName() |
List<AttributeDefinition> |
DataDictionaryEntryBase.getAttributes() |
AttributeSecurity |
AttributeDefinition.getAttributeSecurity() |
String |
ReferenceDefinition.getAttributeToHighlightOnFail()
Gets the attributeToHighlightOnFail attribute.
|
Class<? extends BusinessObject> |
BusinessObjectEntry.getBaseBusinessObjectClass() |
Class<?> |
DataObjectEntry.getBaseDataObjectClass() |
Class<? extends Document> |
DocumentEntry.getBaseDocumentClass()
The optional
Document superclass associated with the document |
String |
WorkflowPropertyGroup.getBasePath()
The base path of the group which all
WorkflowProperty objects are relative to |
String |
InactivationBlockingDefinition.getBlockedAttributeName() |
Class<? extends BusinessObject> |
InactivationBlockingDefinition.getBlockedBusinessObjectClass()
Deprecated.
|
Class<?> |
InactivationBlockingDefinition.getBlockedDataObjectClass() |
String |
InactivationBlockingDefinition.getBlockedReferencePropertyName()
Deprecated.
|
Class<?> |
InactivationBlockingDefinition.getBlockingDataObjectClass() |
Class<? extends BusinessObject> |
InactivationBlockingDefinition.getBlockingReferenceBusinessObjectClass()
Deprecated.
|
Class<?> |
ReferenceDefinition.getBusinessObjectClass() |
Class<? extends BusinessObject> |
InactivationBlockingDefinition.getBusinessObjectClass()
Deprecated.
the businessObjectClass does not appear to be used anywhere significantly internally or externally,
no replacement
|
String |
SearchingAttribute.getBusinessObjectClassName() |
Class<? extends BusinessRule> |
DocumentEntry.getBusinessRulesClass()
The
BusinessRule that will be used to execute business rules for the document |
CaseConstraint |
AttributeDefinition.getCaseConstraint() |
String |
AttributeDefinition.getChildEntryName() |
List<String> |
MaintenanceDocumentEntry.getClearValueOnCopyPropertyNames() |
String |
ReferenceDefinition.getCollection() |
Class<?> |
ReferenceDefinition.getCollectionBusinessObjectClass() |
List<CollectionDefinition> |
DataDictionaryEntryBase.getCollections() |
String |
DictionaryBeanBase.getComponentCode() |
String |
AttributeDefinitionBase.getConstraintText()
Text that display a restriction on the value a field can hold
|
ControlDefinition |
AttributeDefinition.getControl()
Deprecated.
|
Control |
AttributeDefinition.getControlField()
Default
Control to use when the attribute is to be rendered
for the UI. |
String |
AttributeDefinition.getCustomValidatorClass() |
Class<?> |
MaintenanceDocumentEntry.getDataObjectClass() |
Class<?> |
DataObjectEntry.getDataObjectClass() |
DataType |
AttributeDefinition.getDataType()
Returns the Kuali datatype for this field.
|
List<ReferenceDefinition> |
DocumentEntry.getDefaultExistenceChecks()
The defaultExistenceChecks element contains a list of reference object names which are required to exist when
maintaining a BO
|
String |
AttributeDefinitionBase.getDescription()
The description element is used to provide a long description of the
attribute or collection.
|
String |
ReferenceDefinition.getDisplayFieldName()
Gets the displayFieldName attribute.
|
boolean |
DocumentEntry.getDisplayTopicFieldInNotes()
Indicates whether the "Notes and Attachments" tab will render a column for a note topic
|
Class<? extends DocumentAuthorizer> |
DocumentEntry.getDocumentAuthorizerClass()
Full class name for the
DocumentAuthorizer that will authorize actions for this document |
Class<? extends Document> |
DocumentEntry.getDocumentClass()
The
Document subclass associated with the document |
DocumentCollectionPath |
DocumentValuePathGroup.getDocumentCollectionPath() |
Class<? extends DocumentPresentationController> |
DocumentEntry.getDocumentPresentationControllerClass()
Full class name for the
DocumentPresentationController that will be invoked to implement presentation
logic for the document |
String |
DocumentEntry.getDocumentTypeName()
The name of the document in the workflow system
|
List<DocumentValuePathGroup> |
RoutingTypeDefinition.getDocumentValuePathGroups() |
List<String> |
SearchingTypeDefinition.getDocumentValues() |
List<String> |
DocumentValuePathGroup.getDocumentValues() |
String |
AttributeDefinition.getExclusiveMin() |
Class<? extends Exporter> |
DataObjectEntry.getExporterClass() |
Boolean |
AttributeDefinition.getForceUppercase()
Indicates whether user entry should be converted to upper case
|
String |
AttributeDefinition.getFormatterClass()
Deprecated.
|
List<String> |
DataObjectEntry.getGroupByAttributesForEffectiveDating()
Provides list of attributes that should be used for grouping
when performing effective dating logic in the framework
|
HelpDefinition |
DataObjectEntry.getHelpDefinition()
Gets the helpDefinition attribute.
|
String |
DataDictionaryDefinitionBase.getId() |
List<InactivationBlockingDefinition> |
DataObjectEntry.getInactivationBlockingDefinitions()
Gets the inactivationBlockingDefinitions for the Data object
|
String |
InactivationBlockingDefinition.getInactivationBlockingDetectionServiceBeanName() |
String |
AttributeDefinition.getInclusiveMax() |
String |
AttributeDefinitionBase.getLabel()
The label element is the field or collection name that will be shown on
inquiry and maintenance screens.
|
List<String> |
MaintenanceDocumentEntry.getLockingKeys() |
Class<? extends Maintainable> |
MaintenanceDocumentEntry.getMaintainableClass() |
MaskFormatter |
AttributeSecurity.getMaskFormatter() |
Integer |
AttributeDefinition.getMaxLength()
Returns the maximum length for this field, if set.
|
Integer |
AttributeDefinition.getMinLength() |
List<MustOccurConstraint> |
DataObjectEntry.getMustOccurConstraints() |
List<MustOccurConstraint> |
AttributeDefinition.getMustOccurConstraints() |
String |
DataObjectEntry.getName() |
String |
AttributeDefinitionBase.getName()
Name of the attribute
|
String |
DictionaryBeanBase.getNamespaceCode() |
String |
RelationshipDefinition.getObjectAttributeName() |
String |
DataObjectEntry.getObjectDescription() |
String |
DataObjectEntry.getObjectLabel() |
KeyValuesFinder |
AttributeDefinition.getOptionsFinder()
Instance of
KeyValluesFinder that should be invoked to
provide a List of values the field can have. |
String |
HelpDefinition.getParameterDetailType() |
String |
HelpDefinition.getParameterName() |
String |
HelpDefinition.getParameterNamespace() |
MaskFormatter |
AttributeSecurity.getPartialMaskFormatter() |
String |
WorkflowProperty.getPath()
Returns the path to the property that is serializable, relative to the
WorkflowPropertyGroup that
contains this object |
List<PrerequisiteConstraint> |
AttributeDefinition.getPrerequisiteConstraints() |
boolean |
MaintenanceDocumentEntry.getPreserveLockingKeysOnCopy() |
List<String> |
DataObjectEntry.getPrimaryKeys() |
List<PrimitiveAttributeDefinition> |
RelationshipDefinition.getPrimitiveAttributes() |
PropertyEditor |
AttributeDefinition.getPropertyEditor()
Performs formatting of the field value for display and then converting the value back to its
expected type from a string.
|
String |
RoutingAttribute.getQualificationAttributeName() |
String |
InactivationBlockingDefinition.getRelationshipLabel() |
List<RelationshipDefinition> |
DataDictionaryEntryBase.getRelationships() |
List<RoutingAttribute> |
RoutingTypeDefinition.getRoutingAttributes() |
Map<String,RoutingTypeDefinition> |
WorkflowAttributes.getRoutingTypeDefinitions() |
SearchingAttribute |
SearchingTypeDefinition.getSearchingAttribute() |
List<SearchingTypeDefinition> |
WorkflowAttributes.getSearchingTypeDefinitions() |
String |
AttributeDefinitionBase.getShortLabel() |
String |
ExternalizableAttributeDefinitionProxy.getSourceAttributeName() |
Class<?> |
RelationshipDefinition.getSourceClass() |
String |
ExternalizableAttributeDefinitionProxy.getSourceExternalizableBusinessObjectInterface() |
String |
PrimitiveAttributeDefinition.getSourceName() |
StateMapping |
DataDictionaryEntryBase.getStateMapping() |
String |
AttributeDefinitionBase.getSummary()
The summary element is used to provide a short description of the
attribute or collection.
|
List<SupportAttributeDefinition> |
RelationshipDefinition.getSupportAttributes() |
Class<?> |
RelationshipDefinition.getTargetClass()
Returns the
RelationshipDefinition.targetClass |
String |
PrimitiveAttributeDefinition.getTargetName() |
String |
DataObjectEntry.getTitleAttribute() |
boolean |
DocumentEntry.getUsePessimisticLocking()
DataObjectWrapper method for contained usePessimisticLocking
|
boolean |
DocumentEntry.getUseWorkflowPessimisticLocking()
DataObjectWrapper method for contained useWorkflowPessimisticLocking
|
ValidCharactersConstraint |
AttributeDefinition.getValidCharactersConstraint() |
WorkflowAttributes |
DocumentEntry.getWorkflowAttributes() |
List<WorkflowProperty> |
WorkflowPropertyGroup.getWorkflowProperties()
The list of
WorkflowProperty objects |
WorkflowProperties |
DocumentEntry.getWorkflowProperties() |
List<WorkflowPropertyGroup> |
WorkflowProperties.getWorkflowPropertyGroups()
Returns a list of workflow property groups, which are used to determine which properties should be serialized
when generating
routing XML
|
boolean |
DataObjectEntry.isBoNotesEnabled()
Gets the boNotesEnabled flag for the Data object
|
boolean |
DocumentEntry.isEncryptDocumentDataInPersistentSessionStorage()
Indicates that the document data should be encrypted when persisted
|
boolean |
AttributeSecurity.isHide() |
boolean |
SupportAttributeDefinition.isIdentifier() |
boolean |
AttributeSecurity.isMask() |
boolean |
AttributeSecurity.isPartialMask() |
boolean |
AttributeSecurity.isReadOnly() |
Boolean |
AttributeDefinitionBase.isRequired()
The required element allows values of "true" or "false".
|
boolean |
SearchingAttribute.isShowAttributeInResultSet()
Returns whether this attribute should appear in the result set
|
boolean |
SearchingAttribute.isShowAttributeInSearchCriteria()
Returns whether this attribute should appear in the search criteria
|
| Modifier and Type | Method and Description |
|---|---|
String |
MaskFormatterLiteral.getLiteral()
Gets the literalString attribute.
|
String |
MaskFormatterSubString.getMaskCharacter()
Gets the maskCharacter attribute.
|
MaskFormatter |
Mask.getMaskFormatter()
Gets the maskFormatter attribute.
|
Class<? extends MaskFormatter> |
Mask.getMaskFormatterClass()
Gets the maskFormatterClass attribute.
|
int |
MaskFormatterSubString.getMaskLength()
Gets the maskLength attribute.
|
| Modifier and Type | Method and Description |
|---|---|
Map<String,String> |
StateMappingBase.getCustomClientSideValidationStates() |
Map<String,String> |
StateMappingBase.getStateNameMessageKeyMap() |
String |
StateMappingBase.getStatePropertyName() |
List<String> |
StateMappingBase.getStates() |
| Modifier and Type | Method and Description |
|---|---|
List<String> |
DatePatternConstraint.getAllowedFormats() |
boolean |
UTF8AnyCharacterPatternConstraint.getAllowWhitespace() |
boolean |
AnyCharacterPatternConstraint.getAllowWhitespace() |
Boolean |
BaseConstraint.getApplyClientSide()
If this is true, the constraint should be applied on the client side when the user interacts with
a field - if this constraint can be interpreted for client side use.
|
Constraint |
WhenConstraint.getConstraint()
The constraint to apply to the field when the
WhenConstraint value/values match |
List<? extends BaseConstraint> |
BaseConstraint.getConstraintStateOverrides()
Get the list of constraintStateOverrides which represent constraints that will replace THIS constraint
when their state is matched during validation.
|
DataType |
SimpleConstraint.getDataType() |
String |
SimpleConstraint.getExclusiveMin()
Exclusive minimum value for this field
|
String |
SimpleConstraint.getInclusiveMax()
Inclusive max value for this field
|
Integer |
MustOccurConstraint.getMax() |
Integer |
SimpleConstraint.getMaxLength()
The maximum amount of characters this field's value can be
|
Integer |
SimpleConstraint.getMaxOccurs()
The maximum amount of items in this field's list of values - not yet used/do not use
|
String |
BaseConstraint.getMessageComponentCode()
A code within the namespace that identifies a component or group the constraint message is associated with
|
String |
BaseConstraint.getMessageKey()
A key that is used to retrieve the constraint message text (used with the namespace and component
code if specified)
|
String |
BaseConstraint.getMessageNamespaceCode()
Namespace code (often an application or module code) the constraint failure message is associated with
|
Integer |
MustOccurConstraint.getMin() |
Integer |
SimpleConstraint.getMinLength()
The minimum amount of characters this field's value has to be
|
Integer |
SimpleConstraint.getMinOccurs()
The minimum amount of items in this fields list of values - not yet used/do not use
|
List<MustOccurConstraint> |
MustOccurConstraint.getMustOccurConstraints() |
String |
CaseConstraint.getOperator()
specifies the kind of relationship to be checked between the actual value and the ones defined in the
CaseConstraint.getWhenConstraint() |
String |
ConfigurationBasedRegexPatternConstraint.getPatternTypeKey()
Message key used to identify the validation pattern
|
int |
FixedPointPatternConstraint.getPrecision() |
List<PrerequisiteConstraint> |
MustOccurConstraint.getPrerequisiteConstraints() |
String |
PrerequisiteConstraint.getPropertyName() |
String |
CaseConstraint.getPropertyName()
gets the property name for the attribute to which the case constraint is applied to
|
Boolean |
SimpleConstraint.getRequired()
If true the field is required
|
int |
FixedPointPatternConstraint.getScale() |
List<String> |
BaseConstraint.getStates()
A list of states to apply this constraint for, this will effect when a constraint
is applied.
|
List<String> |
BaseConstraint.getValidationMessageParams()
Parameters to be used in the string retrieved by this constraint's messageKey, ordered by number of
the param
|
String |
CharsetPatternConstraint.getValidChars() |
String |
ValidDataPatternConstraint.getValue() |
String |
ValidCharactersPatternConstraint.getValue() |
String |
ValidCharactersConstraint.getValue()
The Java based regex for valid characters
This value should include the ^ and $ symbols if needed
|
String |
WhenConstraint.getValuePath()
Path that can retrieve an attributes value
|
List<Object> |
WhenConstraint.getValues()
List of values to check for this constraint
|
List<WhenConstraint> |
CaseConstraint.getWhenConstraint()
get the
WhenConstraint's defined by this case constraint |
boolean |
AllowCharacterConstraint.isAllowAll()
If true, this constraint will allow all symbols that have flags for them.
|
boolean |
AllowCharacterConstraint.isAllowAmpersand() |
boolean |
AllowCharacterConstraint.isAllowApostrophe() |
boolean |
AllowCharacterConstraint.isAllowAsterisk() |
boolean |
AllowCharacterConstraint.isAllowAtSign() |
boolean |
AllowCharacterConstraint.isAllowBackslash() |
boolean |
AllowCharacterConstraint.isAllowBrackets() |
boolean |
AllowCharacterConstraint.isAllowColon() |
boolean |
AllowCharacterConstraint.isAllowComma() |
boolean |
AllowCharacterConstraint.isAllowCurlyBraces() |
boolean |
AllowCharacterConstraint.isAllowDash() |
boolean |
AllowCharacterConstraint.isAllowDollar() |
boolean |
AllowCharacterConstraint.isAllowDoubleQuote() |
boolean |
AllowCharacterConstraint.isAllowEquals() |
boolean |
AllowCharacterConstraint.isAllowExclaimation() |
boolean |
AllowCharacterConstraint.isAllowForwardSlash() |
boolean |
AllowCharacterConstraint.isAllowGreaterThan() |
boolean |
AllowCharacterConstraint.isAllowLessThan() |
boolean |
IntegerPatternConstraint.isAllowNegative() |
boolean |
FloatingPointPatternConstraint.isAllowNegative() |
boolean |
FixedPointPatternConstraint.isAllowNegative() |
boolean |
AllowCharacterConstraint.isAllowParenthesis() |
boolean |
AllowCharacterConstraint.isAllowPercent() |
boolean |
AllowCharacterConstraint.isAllowPeriod() |
boolean |
AllowCharacterConstraint.isAllowPlus() |
boolean |
AllowCharacterConstraint.isAllowPound() |
boolean |
AllowCharacterConstraint.isAllowQuestionMark() |
boolean |
AllowCharacterConstraint.isAllowSemiColon() |
boolean |
AllowCharacterConstraint.isAllowUnderscore() |
boolean |
AllowCharacterConstraint.isAllowWhitespace() |
boolean |
CaseConstraint.isCaseSensitive()
checks whether string comparison will be carried out in a case sensitive fashion
|
boolean |
AlphaPatternConstraint.isLowerCase() |
boolean |
AlphaNumericPatternConstraint.isLowerCase() |
boolean |
UTF8AnyCharacterPatternConstraint.isOmitNewline() |
boolean |
AnyCharacterPatternConstraint.isOmitNewline() |
boolean |
AllowCharacterConstraint.isOmitNewline() |
boolean |
IntegerPatternConstraint.isOmitZero() |
boolean |
IntegerPatternConstraint.isOnlyNegative() |
boolean |
AlphaPatternConstraint.isUpperCase() |
boolean |
AlphaNumericPatternConstraint.isUpperCase() |
| Modifier and Type | Method and Description |
|---|---|
List<String> |
LookupView.getAdditionalSecurePropertyNames()
List of secure property names that are in addition to the
ComponentSecurity or
AttributeSecurity attributes. |
List<Component> |
LookupView.getCriteriaFields()
List of fields that will be rendered for the lookup criteria.
|
Group |
LookupView.getCriteriaGroup()
Component
Group instance to render as search criteria. |
Class<?> |
LookupView.getDataObjectClass()
Class for the data object the lookup applies to.
|
List<String> |
LookupView.getDefaultSortAttributeNames()
List of property names on the configured data object class that will be used to perform the initial
sorting of the search results.
|
String |
LookupView.getMaintenanceUrlMapping()
String that maps to the maintenance controller for the maintenance document (if any) associated with the
lookup data object class.
|
Integer |
LookupView.getMultipleValuesSelectResultSetLimit()
Retrieves the maximum number of records that will be listed as a result of the multiple
values select lookup search.
|
List<Component> |
LookupView.getResultFields()
List of fields that will be rendered for the result collection group, each field will be a column
(assuming table layout is used).
|
Integer |
LookupView.getResultSetLimit()
Retrieves the maximum number of records that will be listed as a result of the lookup search.
|
CollectionGroup |
LookupView.getResultsGroup()
Component
CollectionGroup instance to render for the lookup results. |
boolean |
LookupInputField.isAddControlSelectAllOption()
Indicates whether the option for all values (blank key, 'All' label) should be added to the lookup
field, note this is only supported for
MultiValueControl instance. |
boolean |
LookupView.isDefaultSortAscending()
Indicates whether the initial sort performed using
LookupView.getDefaultSortAttributeNames() is done based
on ascending or descending order (default is true, ascending). |
boolean |
LookupInputField.isDisableWildcardsAndOperators()
Indicates whether wildcard and other search operators should be disabled (treated as literals) for
the input field.
|
boolean |
LookupView.isMultipleValuesSelect()
Indicates whether multiple values select should be enabled for the lookup.
|
Boolean |
LookupView.isRenderMaintenanceLinks()
Indicates whether links for maintenance actions (new, edit, copy, delete) should be rendered.
|
boolean |
LookupView.isRenderResultActions()
Indicates whether the actions column for the search results collection group should be rendered (default
is true).
|
Boolean |
LookupView.isRenderReturnLink()
Indicates whether a return value link should be rendered for each result row.
|
| Modifier and Type | Method and Description |
|---|---|
List<String> |
ComponentBase.getAdditionalComponentsToRefresh()
Returns a list of componentIds which will be also be refreshed when this component is refreshed
|
List<String> |
ComponentBase.getAdditionalCssClasses()
Convenience property for adding css class names to the end of the list of cssClasses that may already exist on
this Component (this is to avoid explicitly having to set list merge in the bean definition)
|
Map<String,String> |
ComponentSecurity.getAdditionalPermissionDetails()
Map of key value pairs that should be added as permission details when doing KIM permission checks for this
component
|
Map<String,String> |
ComponentSecurity.getAdditionalRoleQualifiers()
Map of key value pairs that should be added as role qualifiers when doing KIM permission checks for this
component
|
String |
ComponentBase.getAlign()
Horizontal alignment of the component within its container
|
Object[] |
MethodInvokerConfig.getArguments() |
Class[] |
MethodInvokerConfig.getArgumentTypes()
Declared argument types for the method to be invoked, if not set the types will
be retrieved based on the target class and target name
|
Map<String,String> |
ComponentBase.getAriaAttributes()
The aria attributes of this component and their values
(without "aria-", this is automatically appended during rendering)
|
String |
BindingInfo.getBindByNamePrefix()
Prefix that will be used to form the binding path from the component
name.
|
String |
BindingInfo.getBindingName()
Gives the name of the property that the component binds to.
|
String |
BindingInfo.getBindingObjectPath()
For attribute fields that do not belong to the default form object (given
by the view), this field specifies the path to the object (on the form)
the attribute does belong to.
|
String |
BindingInfo.getBindingPath()
Path to the property on the model the component binds to.
|
String |
ComponentBase.getCellWidth()
Width setting for the cell containing the component (only applies within table based
layouts)
|
int |
ComponentBase.getColSpan()
Number of places the component should take up horizontally in the
container; when using a CssGridLayoutManager this is converted to the appropriate medium size.
|
String |
ComponentSecurity.getComponentAttribute()
Component code that should be sent as permission detail when doing a permission check on this field
|
List<ComponentModifier> |
ComponentBase.getComponentModifiers()
ComponentModifier instances that should be invoked to
initialize the component |
ComponentSecurity |
ComponentBase.getComponentSecurity()
Security object that indicates what authorization (permissions) exist for the component
|
String |
PropertyReplacer.getCondition()
Gives the expression that should be evaluated to determine whether or not
the property replacement should be made
|
String |
ComponentBase.getConditionalRefresh()
When set if the condition is satisfied, the component will be refreshed.
|
Map<String,Object> |
ComponentBase.getContext()
Context map for the component
|
List<String> |
ComponentBase.getCssClasses()
CSS style class(s) to be applied to the component
|
CssGridSizes |
ComponentBase.getCssGridSizes()
CssGridSizes represent the size (width) the content's div "cell" will take up in the "row" at each screen
size (extra small, small, medium, large) when using a group backed by a CssGridLayoutManager.
|
Map<String,String> |
ComponentBase.getDataAttributes()
The DataAttributes that will be written to the html element for this component as data-
|
List<String> |
ComponentBase.getFieldsToSendOnRefresh()
Limits the field data to send on a refresh methodToCall server call to the names/group id/field id
specified in this list.
|
List<Object> |
ComponentBase.getFinalizeMethodAdditionalArguments()
The List of Object instances that should be passed as arguments to the finalize method
|
MethodInvokerConfig |
ComponentBase.getFinalizeMethodInvoker()
MethodInvokerConfig instance for the method that should be invoked
for finalizing the component configuration |
String |
ComponentBase.getFinalizeMethodToCall()
The name of the method that should be invoked for finalizing the component
configuration (full method name, without parameters or return type)
|
String |
ComponentBase.getId()
The unique id (within a given tree) for the element.
|
String |
ComponentSecurity.getIdAttribute()
Id that should be sent as permission detail when doing a permission check on this field
|
String |
ComponentBase.getMethodToCallOnRefresh()
Name of a method on the controller that should be invoked as part of the component refresh
and disclosure process
|
String |
ComponentSecurity.getNamespaceAttribute()
Namespace code that should be sent as permission detail when doing a permission check on this field
|
String |
ComponentBase.getOnBlurScript()
Script that should be executed when the component's onBlur event is fired
|
String |
ComponentBase.getOnChangeScript()
Script that should be executed when the component's onChange event is
fired
|
String |
ComponentBase.getOnClickScript()
Script that should be executed when the component's onClick event is
fired
|
String |
ComponentBase.getOnCloseScript()
Script that should be executed when the component's onClose event is
fired
|
String |
ComponentBase.getOnDblClickScript()
Script that should be executed when the component's onDblClick event is
fired
|
String |
ComponentBase.getOnDocumentReadyScript()
Script to be run when the document ready event is triggered
|
String |
ComponentBase.getOnFocusScript()
Script that should be executed when the component's onFocus event is
fired
|
String |
ComponentBase.getOnInputScript()
Script that should be executed when the component's onInput event is
fired
|
String |
ComponentBase.getOnKeyDownScript()
Script that should be executed when the component's onKeyDown event is
fired
|
String |
ComponentBase.getOnKeyPressScript()
Script that should be executed when the component's onKeyPress event is
fired
|
String |
ComponentBase.getOnKeyUpScript()
Script that should be executed when the component's onKeyUp event is
fired
|
String |
ComponentBase.getOnLoadScript()
Script that should be executed when the component's onLoad event is fired
|
String |
ComponentBase.getOnMouseDownScript()
Script that should be executed when the component's onMouseDown event is
fired
|
String |
ComponentBase.getOnMouseMoveScript()
Script that should be executed when the component's onMouseMove event is
fired
|
String |
ComponentBase.getOnMouseOutScript()
Script that should be executed when the component's onMouseOut event is
fired
|
String |
ComponentBase.getOnMouseOverScript()
Script that should be executed when the component's onMouseOver event is
fired
|
String |
ComponentBase.getOnMouseUpScript()
Script that should be executed when the component's onMouseUp event is
fired
|
String |
ComponentBase.getOnSubmitScript()
Script that should be executed when the component's onSubmit event is
fired
|
String |
ComponentBase.getOnUnloadScript()
Script that should be executed when the component's onUnload event is
fired
|
int |
ComponentBase.getOrder()
Order of a component within a List of other components
|
String |
ComponentBase.getPostRenderContent()
Raw html or string content to render after this component renders
|
String |
ComponentBase.getPreRenderContent()
Raw html or string content to render before this component renders
|
String |
ComponentBase.getProgressiveRender()
When set if the condition is satisfied, the component will be displayed.
|
String |
PropertyReplacer.getPropertyName()
Name of the property on the Component the property replacer is associated with that
will be set when the condition for the replacer succeeds
|
List<PropertyReplacer> |
ComponentBase.getPropertyReplacers()
gets a list of
PropertyReplacer instances |
Boolean |
ComponentBase.getReadOnly()
Indicates whether the component can be edited
|
int |
ComponentBase.getRefreshTimer()
Time in seconds that the component will be automatically refreshed
|
List<String> |
ComponentBase.getRefreshWhenChangedPropertyNames()
Specifies a property by name that when its value changes will automatically perform
a refresh on this component
|
String |
ComponentBase.getRenderedHtmlOutput()
Rendering output for the component that will be sent as part of the
response (can contain static text and HTML)
|
Object |
PropertyReplacer.getReplacement()
Gives the Object that should be used to set the property value if the replacers condition
evaluates to true
|
Boolean |
ComponentBase.getRequired()
Indicates whether the component is required
|
String |
ComponentBase.getRole()
The role attribute of this component, use to define aria roles
|
int |
ComponentBase.getRowSpan()
Number of places the component should take up vertically in the container
|
Map<String,String> |
ComponentBase.getScriptDataAttributes()
The DataAttributes that will be written to the html as a script call to data for this component (these cannot be
used for jQuery selection directly)
|
String |
MethodInvokerConfig.getStaticMethod()
Set a fully qualified static method name to invoke,
e.g.
|
String |
ComponentBase.getStyle()
CSS style string to be applied to the component
|
Class |
MethodInvokerConfig.getTargetClass() |
String |
MethodInvokerConfig.getTargetMethod() |
Object |
MethodInvokerConfig.getTargetObject() |
String |
ComponentBase.getTemplate()
The path to the JSP file that should be called to render the component
|
String |
ComponentBase.getTemplateName()
The name for which the template can be invoked by
|
Map<String,String> |
ComponentBase.getTemplateOptions()
The options that are passed through to the Component renderer
|
String |
ComponentBase.getTemplateOptionsJSString()
Builds a string from the underlying
Map of template options that will export that options as a
JavaScript Map for use in js and jQuery plugins |
String |
ComponentBase.getTitle()
The component title
|
Tooltip |
ComponentBase.getToolTip()
The Tooltip widget that renders a tooltip with additional information about the element on
specified trigger event
|
String |
ComponentBase.getValign()
Vertical alignment of the component within its container
|
String |
ComponentBase.getWidth()
Width the component should take up in the container
|
List<String> |
ComponentBase.getWrapperCssClasses()
The cellCssClasses property defines the classes that will be placed on the corresponding td (or th) elements
relating to this component when used in a table backed layout.
|
String |
ComponentBase.getWrapperStyle()
CSS style string to be applied to the cell containing the component (only applies within
table based layouts)
|
boolean |
BindingInfo.isBindToForm()
Indicates whether the component binds directly to the form (that is its
bindingName gives a property available through the form), or whether is
binds through a nested form object.
|
boolean |
BindingInfo.isBindToMap()
Indicates whether the parent object for the property that we are binding
to is a Map.
|
boolean |
ComponentBase.isDisableSessionPersistence()
Disables the storage of the component in session (when the framework determines it needs to be due to a
refresh condition)
|
Boolean |
ComponentSecurity.isEditAuthz()
Indicates whether the component has edit authorization and KIM should be consulted
|
Boolean |
ComponentBase.isEditAuthz() |
boolean |
ComponentBase.isForceSessionPersistence()
Indicates whether the component should be stored with the session view regardless of configuration
|
boolean |
ComponentBase.isHidden()
Indicates whether the component should be hidden in the UI
|
boolean |
ComponentBase.isProgressiveRenderAndRefresh()
If true, when the progressiveRender condition is satisfied, the component will always be
retrieved from the server and shown(as opposed to being stored on the client, but hidden,
after the first retrieval as is the case with the progressiveRenderViaAJAX option).
|
boolean |
ComponentBase.isProgressiveRenderViaAJAX()
When progressiveRenderViaAJAX is true, this component will be retrieved from the server when
it first satisfies its progressive render condition.
|
boolean |
ComponentBase.isRender()
Indicates whether the component should be rendered in the UI
|
boolean |
ComponentBase.isResetDataOnRefresh()
Indicates whether data contained within the component should be reset (set to default) when the
component is refreshed
|
boolean |
ComponentBase.isRetrieveViaAjax()
When true, this component will render as a placeholder component instead of rendering normally because the
content will be later retrieved through manually ajax retrieval calls in the js
|
boolean |
ComponentBase.isSelfRendered()
Indicates whether the component contains its own render output (through
the renderOutput property)
|
boolean |
ComponentBase.isSkipInTabOrder()
Flag indicating that this component and its nested components must be skipped when keyboard
tabbing.
|
Boolean |
ComponentSecurity.isViewAuthz()
Indicates whether the component has view authorization and KIM should be consulted
|
Boolean |
ComponentBase.isViewAuthz() |
| Modifier and Type | Method and Description |
|---|---|
Accordion |
AccordionGroup.getAccordionWidget()
Gets the widget which contains any configuration for the accordion widget component used to render
this AccordionGroup.
|
CollectionFilter |
CollectionGroupBase.getActiveCollectionFilter()
Collection filter instance for filtering the collection data when the
showInactive flag is set to false
|
Action |
CollectionGroupBase.getAddBlankLineAction()
The add blank line
Action field rendered when renderAddBlankLineButton is true |
String |
CollectionGroupBase.getAddItemCssClass()
The css style class that will be added on the add item group or row
|
String |
CollectionGroupBase.getAddLabel()
Convenience getter for the add line label field text.
|
List<? extends Component> |
CollectionGroupBase.getAddLineActions()
Component fields that should be rendered for the add line.
|
BindingInfo |
CollectionGroupBase.getAddLineBindingInfo()
BindingInfo instance for the add line property used to
determine the full binding path. |
DialogGroup |
CollectionGroupBase.getAddLineDialog()
Dialog group to use for the add line when
CollectionGroup.isAddWithDialog() is true. |
String |
CollectionGroupBase.getAddLineEnterKeyAction()
Get the id of the add line action to invoke when the enter key is pressed.
|
List<? extends Component> |
CollectionGroupBase.getAddLineItems()
List of
Component instances that should be rendered for the
collection add line (if enabled). |
Message |
CollectionGroupBase.getAddLineLabel()
Message instance for the add line label |
String |
CollectionGroupBase.getAddLinePlacement()
Indicates the add line placement
|
String |
CollectionGroupBase.getAddLinePropertyName()
Name of the property that contains an instance for the add line.
|
Action |
CollectionGroupBase.getAddWithDialogAction()
The
Action that will be displayed that will open the add line group in a dialog. |
List<KeyValue> |
DialogGroup.getAvailableResponses()
List of options that are available for the user to choice as a response to the dialog.
|
BindingInfo |
TreeGroup.getBindingInfo() |
BindingInfo |
LightTable.getBindingInfo()
The bindingInfo for this collection table, containg the property path and other options
|
BindingInfo |
CollectionGroupBase.getBindingInfo()
Returns the
BindingInfo instance that is configured for the
component |
BreadcrumbItem |
PageGroupBase.getBreadcrumbItem()
The breadcrumbItem for this page.
|
PageBreadcrumbOptions |
PageGroupBase.getBreadcrumbOptions()
The breadcrumbOptions specific to this page.
|
String |
SidebarNavigationGroup.getClosedToggleIconClass()
Icon class to use to render a closed icon for sub menus (the
ToggleMenu items) that exist
in this navigation menu. |
CollectionGroupBuilder |
CollectionGroupBase.getCollectionGroupBuilder()
CollectionGroupBuilder instance that will build the
components dynamically for the collection instance |
QuickFinder |
CollectionGroupBase.getCollectionLookup()
Instance of the
QuickFinder widget that configures a multi-value lookup for the collection |
Class<?> |
CollectionGroupBase.getCollectionObjectClass()
Object class the collection maintains.
|
Map<String,String> |
LightTable.getConditionalRowCssClasses()
The row css classes for the rows of this layout
|
protected String |
LightTable.getCurrentColumnValue() |
Group |
NodePrototype.getDataGroupPrototype() |
String |
TabGroup.getDefaultActiveTabId()
Id of the active tab of the tab group when rendered.
|
String |
SidebarNavigationGroup.getDefaultItemIconClass()
The default css class to use for the icons of the items which exist in this navigation menu if they are not set
on the items themselves (icons are required by
Action and ToggleMenu items in this menu). |
int |
ContainerBase.getDefaultItemPosition()
For
Component instances in the container's items list that
do not have an order set, a default order number will be assigned using
this property. |
NodePrototype |
TreeGroup.getDefaultNodePrototype() |
String |
DialogGroup.getDialogCssClass()
Gets CSS class to use when rendering dialog (default is modal-sm).
|
Disclosure |
GroupBase.getDisclosure()
Disclosure widget that provides collapse/expand functionality for the
group
|
int |
CollectionGroupBase.getDisplayCollectionSize()
The number of records to display for a collection
|
List<String> |
CollectionGroupBase.getDuplicateLinePropertyNames()
List of property names that should be checked for duplicates in the collection.
|
Action |
CollectionGroupBase.getEditInDialogSaveActionPrototype()
The
Action that will be displayed within the edit line group in a dialog. |
DialogGroup |
CollectionGroupBase.getEditLineDialogPrototype()
Dialog group prototype to use to create the edit line dialog when
CollectionGroup.isEditWithDialog()
is true. |
Action |
CollectionGroupBase.getEditWithDialogActionPrototype()
The
Action that will be displayed that will open the edit line group in a dialog. |
String |
LinkGroup.getEmptyLinkGroupString()
String that will be outputted when the list backing the
link group is empty
|
String |
ContainerBase.getEnterKeyAction()
Get the key of the action item to invoke upon pressing the enter key.
|
InputField |
DialogGroup.getExplanation()
Input field use to gather explanation text with the dialog.
|
String |
ELCollectionFilter.getExpression()
Expression that will be evaluated for each line to determine whether the line should be filtered
|
String |
GroupBase.getFieldBindByNamePrefix()
Binding prefix string to set on each of the groups
DataField instances |
String |
GroupBase.getFieldBindingObjectPath()
Object binding path to set on each of the group's
InputField instances |
List<CollectionFilter> |
CollectionGroupBase.getFilters()
List of
CollectionFilter instances that should be invoked to filter the collection before
displaying |
Group |
ContainerBase.getFooter()
Footer
Group associated with the container |
String |
PageGroupBase.getFormPostUrl()
Specifies the URL the view's form should post to
|
String |
LinkGroup.getGroupBeginDelimiter()
String that will be rendered before the group of links are rendered
|
String |
LinkGroup.getGroupEndDelimiter()
String that will be rendered after the group of links are rendered
|
Header |
ContainerBase.getHeader()
HeaderField associated with the container |
String |
ContainerBase.getHeaderText()
Convenience getter for the header text
|
Help |
ContainerBase.getHelp()
Help configuration object for the container
|
Message |
ContainerBase.getInstructionalMessage()
Message field that displays instructional text
|
String |
ContainerBase.getInstructionalText()
Text explaining how complete the group inputs, including things like what values should be selected
in certain cases, what fields should be completed and so on (instructions)
|
List<? extends Component> |
GroupBase.getItems()
List of Component instances that are held by
the container |
abstract List<? extends Component> |
ContainerBase.getItems()
List of Component instances that are held by
the container |
List<? extends Component> |
CollectionGroupBase.getItems()
List of Component instances that are held by
the container |
Message |
NodePrototype.getLabelPrototype() |
LayoutManager |
ContainerBase.getLayoutManager()
LayoutManager that should be used to layout the components
in the container |
List<? extends Component> |
CollectionGroupBase.getLineActions()
Action fields that should be rendered for each collection line.
|
String |
CollectionGroupBase.getLineEnterKeyAction()
Get the id of the nonAdd line action to invoke when the enter key is pressed.
|
String |
CollectionGroupBase.getLineSelectPropertyName()
When
CollectionGroup.isIncludeLineSelectionField() is true, gives the name of the property the select field
should bind to |
String |
LinkGroup.getLinkSeparator()
String that will be rendered between each rendered link
e.g.
|
String |
CollectionGroupBase.getNewItemsCssClass()
The css style class that will be added on new items
|
Map<Class<?>,NodePrototype> |
TreeGroup.getNodePrototypeMap() |
String |
MaintenanceActiveCollectionFilter.getOldBindingObjectPath()
Gives the binding path to the old data object for comparison, used to
get the active status of the old object
|
String |
DialogGroup.getOnDialogResponseScript()
Script that will be invoked when the dialog response event is thrown.
|
String |
DialogGroup.getOnShowDialogScript()
Script that will get invoked when the dialog group is shown.
|
String |
SidebarNavigationGroup.getOpenedToggleIconClass()
Icon class to use to render a opened icon for sub menus (the
ToggleMenu items) that exist
in this navigation menu. |
MessageField |
DialogGroup.getPrompt()
Message component to use for the dialog prompt.
|
String |
DialogGroup.getPromptText()
Text to be displayed as the prompt or main message in this simple dialog.
|
String |
TreeGroup.getPropertyName() |
String |
LightTable.getPropertyName()
The propertyName of the list backing this collection
|
String |
CollectionGroupBase.getPropertyName()
Name of the property (relative to the parent object) the component binds
to
|
RichTable |
LightTable.getRichTable()
The richTable widget definition for this table for setting dataTable javascript options
|
Scrollpane |
GroupBase.getScrollpane()
Scrollpane widget that provides scrolling functionality for the
group
|
List<CollectionGroup> |
CollectionGroupBase.getSubCollections()
List of
CollectionGroup instances that are sub-collections
of the collection represented by this collection group |
Tabs |
TabGroup.getTabsWidget()
Gets the widget which contains any configuration for the tab widget component used to render
this TabGroup
|
protected List<String> |
CollectionGroupBase.getTotalColumns() |
Tree |
TreeGroup.getTree() |
Tree<Group,Message> |
TreeGroup.getTreeGroups() |
ValidationMessages |
ContainerBase.getValidationMessages()
Field that contains the error messages for the container
|
String |
GroupBase.getWrapperTag()
Defines the html tag that will wrap this group, if left blank, this will automatically be set
by the framework to the appropriate tag (in most cases section or div)
|
boolean |
CollectionGroupBase.isAddWithDialog()
Indicates that a add action should be rendered and that the add group be displayed in a model dialog.
|
boolean |
PageGroupBase.isAutoFocus()
When this is true, the first field of the kualiForm will be focused by
default, unless the parameter focusId is set on the form (by an
actionField), then that field will be focused instead.
|
boolean |
CollectionGroupBase.isCustomEditLineDialog()
Indicates that a custom edit line dialog is provided by the user.
|
boolean |
CollectionGroupSecurity.isEditLineAuthz()
Indicates whether the collection group line has edit authorization and KIM should be consulted
|
boolean |
CollectionGroupBase.isEditLineAuthz() |
boolean |
CollectionGroupBase.isEditWithDialog()
Indicates that an edit action should be rendered and that the edit group be displayed in a model dialog.
|
boolean |
CollectionGroupBase.isHighlightAddItem()
Indicates whether the add item group or row should be styled with the #addItemCssClass
|
boolean |
CollectionGroupBase.isHighlightNewItems()
Indicates whether new items should be styled with the #newItemsCssClass
|
boolean |
CollectionGroupBase.isIncludeLineSelectionField()
Indicates whether lines of the collection group should be selected by rendering a
field for each line that will allow selection
|
boolean |
CollectionGroupBase.isRenderAddBlankLineButton()
Indicates that a button will be rendered that allows the user to add blank lines to the collection
|
boolean |
CollectionGroupBase.isRenderAddLine()
Indicates whether an add line should be rendered for the collection
|
boolean |
SidebarNavigationGroup.isRenderCollapse()
When true, render the collapse icon (an icon that the user can click to close/open the sidebar navigation).
|
boolean |
CollectionGroupBase.isRenderInactiveToggleButton() |
boolean |
CollectionGroupBase.isRenderLineActions()
Indicates whether the action column for the collection should be rendered
|
boolean |
CollectionGroupBase.isRenderSaveLineActions()
Indicates whether the save line actions should be rendered
|
boolean |
CollectionGroupBase.isShowInactiveLines()
Indicates whether inactive collections lines should be displayed
|
boolean |
PageGroupBase.isStickyFooter()
When true, this page's footer will become sticky (fixed) at the bottom of the window
|
boolean |
CollectionGroupBase.isUseServerPaging()
Gets useServerPaging, the flag that indicates whether server side paging is enabled.
|
boolean |
CollectionGroupSecurity.isViewLineAuthz()
Indicates whether the collection group line has view authorization and KIM should be consulted
|
boolean |
CollectionGroupBase.isViewLineAuthz() |
| Modifier and Type | Method and Description |
|---|---|
String |
CheckboxControl.getCheckboxLabel()
Returns the label text for this checkbox
|
int |
TextAreaControl.getCols()
Number of columns the control should span (vertical length)
|
DatePicker |
TextControlBase.getDatePicker()
Renders a calendar that can be used to select a date value for the text control.
|
String |
RadioGroupControl.getDelimiter()
Delimiter string to be rendered between the radio group options, defaults
to none
|
String |
CheckboxGroupControl.getDelimiter()
Delimiter string to be rendered between the checkbox group options
|
String |
ControlBase.getDisabledReason() |
List<String> |
ControlBase.getDisabledWhenChangedPropertyNames()
Gets the property names of fields that when changed, will disable this component
|
List<String> |
ControlBase.getEnabledWhenChangedPropertyNames()
Gets the property names of fields that when changed, will enable this component
|
List<String> |
RadioGroupControl.getFieldsetClasses()
Get fieldsetClasses which are the classes that will be applied to this component's fieldset when generated
|
List<String> |
CheckboxGroupControl.getFieldsetClasses()
Get fieldsetClasses which are the classes that will be applied to this component's fieldset when generated
|
String |
GroupControl.getGroupIdPropertyName()
The name of the property on the parent object that holds the group id
|
List<Component> |
MultiValueControlBase.getInlineComponents()
Gets the inlineComponents which represent components that can be referenced in an option's value
by index
|
List<Component> |
CheckboxControl.getInlineComponents()
Gets the inlineComponents used by index in the checkboxLabel that has rich message component index tags
|
String |
OptionListControl.getItemCssClass()
The item css class to add to each li element of the list
|
Integer |
TextControlBase.getMaxLength()
Maximum number of characters that can be inputted.
|
Integer |
TextAreaControl.getMaxLength()
Maximum number of characters that can be inputted
|
Integer |
PasswordControl.getMaxLength()
Maximum number of characters that can be inputted
|
Integer |
TextControlBase.getMinLength()
Minimum number of characters that can be inputted.
|
Integer |
TextAreaControl.getMinLength()
Minimum number of characters that can be inputted
|
Integer |
PasswordControl.getMinLength()
Minimum number of characters that can be inputted
|
String |
GroupControl.getNamespaceCodePropertyName()
The name of the property on the parent object that holds the group namespace
|
List<KeyValue> |
MultiValueControlBase.getOptions() |
String |
UserControl.getPersonNamePropertyName()
The name of the property on the parent object that holds the person name
|
String |
UserControl.getPersonObjectPropertyName()
The name of the property on the parent object that holds the person object
|
String |
UserControl.getPrincipalIdPropertyName()
The name of the property on the parent object that holds the principal id
|
Message |
CheckboxControl.getRichLabelMessage()
Gets the Message that represents the rich message content of the label if labelText is using rich message tags.
|
int |
TextAreaControl.getRows()
Number of rows the control should span (horizontal length)
|
String |
OptionListControl.getSelectedItemCssClass()
The css class to add to each item of the list which matches a value in the property
|
int |
TextControlBase.getSize()
Retrieves the configured size for the control, which reflects the display width in characters for
the control within the UI
|
int |
SelectControlBase.getSize()
This overridden method ...
|
int |
PasswordControl.getSize() |
int |
FileControl.getSize() |
Spinner |
SpinnerControl.getSpinner()
Spinner widget that should decorate the control
|
int |
ControlBase.getTabIndex()
Unique index of the control within the tab order
|
String |
CheckboxControl.getValue()
The value that will be submitted when the checkbox control is checked
|
String |
TextControlBase.getWatermarkText()
Gets the watermark text for this TextControl.
|
String |
TextAreaControl.getWatermarkText() |
String |
PasswordControl.getWatermarkText()
Gets the watermark text for this PasswordControl.
|
boolean |
UifKeyValuesFinderBase.isAddBlankOption()
Indicates whether a blank option should be included as a valid option
|
boolean |
ControlBase.isDisabled() |
boolean |
ControlBase.isEvaluateDisabledOnKeyUp()
Evaluate the disable condition on controls which disable it on each key up event
|
boolean |
SelectControlBase.isMultiple()
Indicates whether multiple values can be selected.
|
boolean |
OptionListControl.isShowOnlySelected()
When true, only show the "selected" options (items which match a value in the property of the field).
|
boolean |
TextControlBase.isTextExpand()
If set to true, this control will have a button which can be clicked to expand the text area through
a popup window so the user has more space to type and see the data they are entering in this text field.
|
boolean |
TextAreaControl.isTextExpand()
If set to true, this control will have a button which can be clicked to expand the text area through
a popup window so the user has more space to type and see the data they are entering in this text field
|
| Modifier and Type | Method and Description |
|---|---|
String |
MultiFileUploadCollection.getAcceptFileTypes()
A regex used to allow or disallow a certain file types for this file upload component
|
String |
Action.getActionEvent()
Name of the event that will be set when the action is invoked
|
String |
Action.getActionIconPlacement()
Gets the action icon placement.
|
Image |
Action.getActionImage()
Image to use for the action
|
String |
Action.getActionImagePlacement()
Gets the action image placement.
|
String |
Action.getActionLabel()
Label text for the action
|
Map<String,String> |
Action.getActionParameters()
Parameters that should be sent when the action is invoked
|
String |
Action.getActionScript()
Client side javascript to be executed when this actionField is clicked.
|
UrlInfo |
Action.getActionUrl()
Url to open when the action item is selected
|
String |
MultiFileUploadCollection.getAddFilesButtonText()
The text to be used on the add files button
|
List<String> |
ValidationMessages.getAdditionalKeysToMatch()
AdditionalKeysToMatch is an additional list of keys outside of the
default keys that will be matched when messages are returned after a form
is submitted.
|
Map<String,String> |
Action.getAdditionalSubmitData()
Map of additional data that will be posted when the action is invoked.
|
String |
Action.getAjaxReturnType()
Gets the return type for the ajax call
|
String |
DataTable.getAjaxSource() |
String |
Image.getAltText()
Provides alternate information for the image element
|
Message |
ViewHeader.getAreaTitleMessage()
Message object backing areaTitleText
|
String |
ViewHeader.getAreaTitleText()
Represents the area in which this view and page exist (conceptially in the site);
this title appears above the view title.
|
Image |
NavigationBar.getBrandImage()
Image component instance to use for the application branding.
|
String |
NavigationBar.getBrandText()
Header text to use for the application branding.
|
String |
NavigationBar.getBrandUrl()
String of URL set in rendering the navigation component.
|
List<BreadcrumbItem> |
BreadcrumbOptions.getBreadcrumbOverrides()
The breadcrumbOverrides are a complete override for all breadcrumbs shown expect for parent location/path
breadcrumbs.
|
Header |
Image.getCaptionHeader()
Retrieves the
Header component used to display the caption for this image |
String |
Image.getCaptionHeaderText()
Retrieves the caption text for this image
|
CollectionGroup |
MultiFileUploadCollection.getCollection()
The collection which holds the files uploaded
|
String |
StepProgressBar.getCompleteStep()
The key that when currentStep has this value, shows the step progress bar as fully complete; this key
is must not be part of the steps being shown, by default this has a value of "SUCCESS".
|
String |
MetaTag.getContent()
Content attribute for meta tag.
|
String |
StepProgressBar.getCurrentStep()
The current step (by key) of this progress bar to be highlighted visually as the active step.
|
Message |
Image.getCutlineMessage()
Gets the
Message component used to display the cutline. |
String |
Image.getCutlineText()
Retrieves the cutline text for this image
|
String |
Action.getDisabledReason()
If the action field is disabled, gives a reason for why which will be displayed as a tooltip
on the action field (button).
|
List<String> |
Action.getDisabledWhenChangedPropertyNames()
Gets the property names of fields that when changed, will disable this component.
|
List<String> |
Action.getEnabledWhenChangedPropertyNames()
Gets the property names of fields that when changed, will enable this component.
|
String |
Action.getErrorCallback()
Gets the script which will be invoked when the action fails due to problems in the ajax call or
the return of an incident report
|
List<String> |
ValidationMessages.getErrors()
The list of error messages found for the keys that were matched on this
ValidationMessages This is generated and cannot be set
|
List<String> |
Action.getFieldsToSend()
Limits the field data to send on a refresh methodToCall server call to the names/group id/field id
specified in this list.
|
String |
NumberedPager.getFirstText()
The text to use on the first link.
|
String |
Action.getFocusOnIdAfterSubmit()
The element to place focus on in the new page after the new page
is retrieved.
|
String |
Iframe.getFrameborder()
The IFrame's frame border
|
String |
Header.getHeaderLevel()
HTML header level (h1 ...
|
List<String> |
Header.getHeaderTagCssClasses()
Style classes that should be applied to the header text (h tag)
|
String |
Header.getHeaderTagStyle()
Style that should be applied to the header h tag
|
String |
Header.getHeaderText()
Text that should be displayed on the header
|
String |
Image.getHeight()
Returns the height style attribute of this image
|
String |
Iframe.getHeight()
The IFrame's height
|
Set<String> |
DataTable.getHiddenColumns() |
List<BreadcrumbItem> |
BreadcrumbOptions.getHomewardPathBreadcrumbs()
The homewardPathBreadcrumbs represent the path to "Home" location, these appear before anything else - including
parentLocation/path based breadcrumbs.
|
String |
Link.getHref()
Returns the href text
|
String |
HeadLink.getHref()
Href attribute for link tag.
|
String |
MetaTag.getHttp_equiv()
Http_equiv attribute for meta tag.
|
String |
ToggleMenu.getIconClass()
Css class for an icon that will appear to the left of the toggleText
|
String |
Link.getIconClass()
Icon Class for the link
|
String |
Icon.getIconClass()
Icon Class for the action
|
String |
Action.getIconClass()
The css class (some which exist in bootstrap css) to use to render an icon for this action.
|
String |
HeadLink.getIncludeCondition()
IncludeCondition wraps custom html comments around link tags.
|
List<String> |
ValidationMessages.getInfos()
The list of info messages found for the keys that were matched on this
ValidationMessages This is generated and cannot be set
|
List<Component> |
Message.getInlineComponents()
The inlineComponents are a list of components in order by index.
|
List<Component> |
Label.getInlineComponents()
Gets the inlineComponents used by index in a Label that has rich message component index tags in its labelText
|
List<Component> |
Header.getInlineComponents()
Gets the inlineComponents used by index in a Header that has rich message component index tags in its headerText
|
List<? extends Component> |
NavigationBar.getItems()
Convenience getter for the navigation group items.
|
List<? extends Component> |
Header.getItems()
List of
Component instances contained in the lower header group |
String |
Action.getJumpToIdAfterSubmit()
Gets the id to jump to after submit.
|
String |
Action.getJumpToNameAfterSubmit()
The name to jump to in the next page, the element with this name will be
jumped to automatically when the new page is retrieved after a submit.
|
String |
BreadcrumbItem.getLabel()
The label for this breadcrumbItem.
|
String |
Label.getLabelForComponentId()
Indicates the id for the component the label applies to
|
String |
Label.getLabelText()
Text that will display as the label
|
String |
NumberedPager.getLastText()
The text to use for the last link.
|
String |
Link.getLinkDialogId()
The id of the DialogGroup to use when the openInDialog property is true.
|
String |
Link.getLinkIconPlacement()
Set to LEFT, RIGHT to position image at that location within the button.
|
String |
Pager.getLinkScript()
The script to execute when a link is clicked (should probably use the "this" var in most cases, to determine
page number selected - see retrieveStackedPage(linkElement, collectionId) js function)
|
String |
Link.getLinkText()
Returns the label of the link
|
String |
Action.getLoadingMessageText()
Gets the loading message used by action's blockUI.
|
Group |
Header.getLowerGroup()
Nested group instance that can be used to render contents below the header text
|
Integer |
MultiFileUploadCollection.getMaxFileSize()
The maximum file size to allow (in bytes) for a file upload
|
int |
NumberedPager.getMaxNumberedLinksShown()
The maximum number of NUMBERED links shown at once for pages, if number of pages that exist exceed this value,
the pager omits some pages before and/or after the current page (which are revealed during while
navigating using a carousel effect)
|
String |
HeadLink.getMedia()
Media attribute for link tag.
|
Group |
ToggleMenu.getMenuGroup()
Group instance that is rendered when the toggle menu is toggled.
|
List<Component> |
ToggleMenu.getMenuItems()
List of components that should be rendered for the toggle menu.
|
String |
Message.getMessageText()
Text that makes up the message that will be displayed.
|
Message |
ViewHeader.getMetadataMessage()
The metadataMessage represents any relevant metadata about the view (last saved, etc).
|
String |
ViewHeader.getMetadataText()
The metadataText represents any relevant metadata about the view (last saved, etc).
|
String |
MultiFileUploadCollection.getMethodToCall()
The methodToCall for uploading files, this methodToCall must return the refreshed collection
|
String |
Action.getMethodToCall()
Name of the method that should be called when the action is selected
|
Integer |
MultiFileUploadCollection.getMinFileSize()
The minimum file size needed (in bytes) for a file to be uploaded
|
String |
MetaTag.getName()
Name attribute for meta tag.
|
String |
Action.getNavigateToPageId()
For an
Action that is part of a
NavigationGroup, the navigate to page id can be set to
configure the page that should be navigated to when the action is
selected. |
Group |
NavigationBar.getNavigationBarGroup()
Group instance that holds the navigation items (such as links) for the navigation bar.
|
String |
Pager.getNextText()
The text to use on the next link.
|
Integer |
ProgressBar.getPercentComplete()
Percent value complete used to visually indicate this ProgressBar's completeness
|
List<BreadcrumbItem> |
BreadcrumbOptions.getPrePageBreadcrumbs()
The prePageBreadcrumbs list represents BreadcrumbItems that will be shown before the PageGroup's BreadcrumbItem,
but after the View's BreadcrumbItem.
|
String |
Action.getPreSubmitCall()
Gets the script which needs to be invoked before the form is submitted
|
List<BreadcrumbItem> |
BreadcrumbOptions.getPreViewBreadcrumbs()
The preViewBreadcrumbs list represents BreadcrumbItems that will be shown before the View's BreadcrumbItem,
but after any parent location breadcrumbs/path based breadcrumbs (if in use)
|
String |
Pager.getPrevText()
The text to use on the previous link.
|
String |
Action.getRefreshId()
Id for the component that should be refreshed after the action completes
|
String |
Action.getRefreshPropertyName()
Property name for the
DataField that should be refreshed after the action
completes |
String |
HeadLink.getRelation()
Rel attribute for link tag.
|
String |
Label.getRequiredIndicator()
String indicator that will be displayed as a required indicator
|
Message |
Header.getRichHeaderMessage()
Gets the Message that represents the rich message content of the header if headerText is using rich message
tags.
|
Message |
Label.getRichLabelMessage()
Gets the Message that represents the rich message content of the label if labelText is using rich message tags.
|
RichTable |
DataTable.getRichTable()
Widget that will render the data table client side
|
Group |
Header.getRightGroup()
Nested group instance that can be used to render contents to the right of the header text
|
List<String> |
ProgressBar.getSegmentClasses()
List of bar classes to use for each bar "section" for coloring or styling purposes, only settable for
full configuration purposes and should not normally be set
|
List<Integer> |
ProgressBar.getSegmentPercentages()
The percentage each bar "section" will take up on the progress bar, only settable for
full configuration purposes and should not normally be set
|
Component |
BreadcrumbItem.getSiblingBreadcrumbComponent()
Set the breadcrumb component for this breadcrumbs sibling content/navigation.
|
Set<String> |
DataTable.getSortableColumns() |
String |
Image.getSource()
returns the URL of this image
|
String |
Iframe.getSource()
The IFrame's source
|
Map<String,String> |
StepProgressBar.getSteps()
The steps as key-value pairs for this StepProgressBar, where value is human-readable text.
|
String |
Action.getSuccessCallback()
Gets the script which will be invoked on a successful ajax call
|
Message |
ViewHeader.getSupportTitleMessage()
The supportTitleMessage represents the sub-area of this view that supports what the page is displaying, this is
the Message component
|
String |
ViewHeader.getSupportTitleText()
The supportTitleText represents the sub-area of this view that explains what the page is displaying; this is
the text used in supportTitleMessage
|
String |
Link.getTarget()
Returns the target that will be used to specify where to open the href
|
String |
ToggleMenu.getToggleCaretClass()
Css class to use when rendering a caret icon which will appear to the right of the toggleText
|
Message |
ToggleMenu.getToggleMessage()
Message component that is associated with the toggle menu toggle text, can be used to adjust styling
and so forth |
String |
ToggleMenu.getToggleText()
Text to display as the toggle menu toggle link
|
String |
HeadLink.getType()
Type attribute for link tag.
|
Group |
Header.getUpperGroup()
Nested group instance that can be used to render contents above the header text
|
UrlInfo |
MultiFileUploadCollection.getUrl()
The url override for file uploads, this will be used instead of the methodToCall, if set, as the url to post
the file upload to
|
UrlInfo |
BreadcrumbItem.getUrl()
The url used for the breadcrumb link represented by this item
|
Integer |
StepProgressBar.getVerticalHeight()
The height (in pixels) of the progress bar portion of this component, if this is not set, verticalStepHeight
is used to calculate this value; only used when vertical property is true.
|
Integer |
StepProgressBar.getVerticalStepHeight()
The height (in pixels) allocated for each step for vertical step display used to calculate verticalHeight if not
set, by default this is 75.
|
List<String> |
ValidationMessages.getWarnings()
The list of warning messages found for the keys that were matched on this
ValidationMessages This is generated and cannot be set
|
String |
Image.getWidth()
Returns the width style attribute of the image
|
String |
Message.getWrapperTag()
Defines the html tag that will wrap this message, if left blank, this will automatically be set by the framework
to the appropriate tag (in most cases p or div)
|
boolean |
Action.isAjaxSubmit()
When this property is set to true it will submit the form using Ajax instead of the browser submit.
|
boolean |
Image.isCaptionHeaderPlacementAboveImage()
Specifies whether the image caption is to be displayed above or below the image
|
boolean |
NextPager.isCenteredLinks()
When false, links will receive the next and previous classes which left and right align the links instead
of centering them.
|
boolean |
Action.isClearDirtyOnAction()
True to make this action clear the dirty flag before submitting.
|
boolean |
GroupValidationMessages.isCollapseAdditionalFieldLinkMessages()
When collapseAdditionalFieldLinkMessages is set to true, the messages generated on field links will be
summarized to limit the space they take up with an appendage similar to [+n message type] appended for
additional
messages that are omitted.
|
boolean |
Action.isDefaultEnterKeyAction()
Evaluate if this action is the default action for a page, view, group, or section.
|
boolean |
Action.isDirtyOnAction()
When true, this action will mark the form dirty by incrementing the dirty field count, but if this action
refreshes the entire view this will be lost (most actions only refresh the page)
|
boolean |
Action.isDisableBlocking()
Indicates whether blocking for the action should be disabled
|
boolean |
Action.isDisabled()
Indicates whether the action (input or button) is disabled (doesn't allow interaction).
|
boolean |
GroupValidationMessages.isDisplayFieldLabelWithMessages()
If true, the error messages will display the an InputField's title
alongside the error, warning, and info messages related to it.
|
boolean |
GroupValidationMessages.isDisplayHeaderMessageSummary()
If true, the header message summary will display (this is the message count message appended to section
headers).
|
boolean |
ValidationMessages.isDisplayMessages()
If true, error, warning, and info messages will be displayed (provided
they are also set to display).
|
boolean |
Action.isDisplayResponseInLightBox()
Indicates if the action response should be displayed in a lightbox.
|
boolean |
Action.isEvaluateDisabledOnKeyUp()
Evaluate the disable condition on controls which disable it on each key up event.
|
boolean |
Header.isHeaderTagOnly() |
boolean |
Link.isOpenInDialog()
Indicates whether the link URL should be opened in a dialog.
|
boolean |
Message.isParseComponents()
Indicates if the inline components must be parsed for rich messages
|
boolean |
ActionSecurity.isPerformActionAuthz()
Indicates whether the action field has take action authorization and KIM should be consulted
|
boolean |
Action.isPerformActionAuthz()
Indicates whether or not to perform action auth.
|
boolean |
Action.isPerformClientSideValidation()
Indicates whether the form data should be validated on the client side.
|
boolean |
Action.isPerformDirtyValidation()
Indicates whether or not to perform dirty validation.
|
boolean |
ActionSecurity.isPerformLineActionAuthz()
Indicates whether the line action field has take action authorization and KIM should be consulted
|
boolean |
Action.isPerformLineActionAuthz()
Indicates whether or not to perform line action auth.
|
boolean |
BreadcrumbItem.isRenderAsLink()
If true, the breadcrumbItem will render as a link, otherwise it will render as a span (not-clickable).
|
boolean |
Label.isRenderColon()
Indicates whether a colon should be rendered after the label text,
generally used when the label appears to the left of the field's control
or value
|
boolean |
ToggleMenu.isRenderedInList() |
boolean |
NumberedPager.isRenderFirstLast()
Returns true if this pager widget is rendering the "First" and "Last" links
|
boolean |
PageBreadcrumbOptions.isRenderHomewardPathBreadcrumbs()
If true, render the homewardPathBreadcrumbs (if any are set), otherwise do not render them
|
boolean |
Action.isRenderInnerTextSpan()
When true, a span will be rendered around the actionLabel text.
|
boolean |
PageBreadcrumbOptions.isRenderParentLocations()
If true, render the parent location breadcrumbs.
|
boolean |
PageBreadcrumbOptions.isRenderPrePageBreadcrumbs()
If true, render the prePageBreadcrumbs (if any are set), otherwise do not render them
|
boolean |
PageBreadcrumbOptions.isRenderPreViewBreadcrumbs()
If true, render the preViewBreadcrumbs (if any are set), otherwise do not render them
|
boolean |
NumberedPager.isRenderPrevNext()
Returns true if this pager widget is rendering the "Prev" and "Next" links
|
boolean |
ToggleMenu.isRenderToggleButton()
Indicates whether a caret button should be rendered to the right of the toggle text (if present)
|
boolean |
PageBreadcrumbOptions.isRenderViewBreadcrumb()
Whether or not to render the view breadcrumb at this level
|
boolean |
Message.isRenderWrapperTag()
If true, render the wrapper element (p or div) around this message (default true).
|
boolean |
FieldValidationMessages.isShowIcons()
If true, display dynamic icons next to fields which have messages.
|
boolean |
PageValidationMessages.isShowPageSummaryHeader()
If true, shows the page summary header (message count header message in the message block).
|
boolean |
ViewHeader.isSticky()
If true, this ViewHeader will be sticky (fixed to top of window, stays at top during scrolling)
|
boolean |
FieldValidationMessages.isUseTooltip()
When true, use the tooltip on fields to display their relevant messages.
|
boolean |
ProgressBar.isVertical()
True if this ProgressBar should render vertical (this requires a defined height - which by default is
defined in the css, or by the framework for StepProgressBars), false otherwise
|
| Modifier and Type | Method and Description |
|---|---|
Action |
ActionField.getAction()
Nested action component.
|
String |
ActionField.getActionEvent()
Delegates to
Action.getActionEvent(). |
Image |
ActionField.getActionImage()
Delegates
actionImage property reference to the action. |
String |
ActionField.getActionImagePlacement() |
String |
ActionField.getActionLabel()
Delegates
actionLabel property reference to the action. |
Map<String,String> |
ActionField.getActionParameters() |
String |
ActionField.getActionScript() |
Map<String,String> |
AttributeQuery.getAdditionalCriteria()
Fixed criteria that will be appended to the dynamic criteria generated
for the query.
|
List<String> |
DataFieldBase.getAdditionalHiddenPropertyNames()
Allows specifying hidden property names without having to specify as a
field in the group config (that might impact layout)
|
Map<String,String> |
UserLinkField.getAdditionalInquiryParameters()
Map that determines what additional properties from a calling view will be sent to properties on the inquiry data object.
|
Map<String,String> |
RoleLinkField.getAdditionalInquiryParameters()
Map that determines what additional properties from a calling view will be sent to properties on the inquiry data object.
|
Map<String,String> |
GroupLinkField.getAdditionalInquiryParameters()
Map that determines what additional properties from a calling view will be sent to properties on the inquiry data object.
|
Map<String,String> |
ActionField.getAdditionalSubmitData() |
String |
ImageField.getAltText()
Provides alternate information for the image element
|
AttributeQuery |
InputFieldBase.getAttributeQuery()
Attribute query instance configured for this field to dynamically pull information back for
updates other fields or providing messages
|
AttributeSecurity |
DataFieldSecurity.getAttributeSecurity()
Attribute security instance configured or picked up for the field
|
String |
UserLinkField.getBaseInquiryUrl()
BaseInquiryUrl is the foundation of generated inquiry link url.
|
String |
RoleLinkField.getBaseInquiryUrl()
BaseInquiryUrl is the foundation of generated inquiry link url.
|
String |
GroupLinkField.getBaseInquiryUrl()
BaseInquiryUrl is the foundation of generated inquiry link url
|
BindingInfo |
RemoteFieldsHolder.getBindingInfo()
Can be used to for more complex binding paths
|
BindingInfo |
DataFieldBase.getBindingInfo()
Returns the
BindingInfo instance that is configured for the
component |
Header |
ImageField.getCaptionHeader()
Gets the caption header
|
String |
ImageField.getCaptionHeaderText()
Gets the caption header text
|
CaseConstraint |
InputFieldBase.getCaseConstraint() |
Message |
InputFieldBase.getConstraintMessage()
Message field that displays constraint text
|
String |
InputFieldBase.getConstraintText()
Text that display a restriction on the value a field can hold
|
Control |
InputFieldBase.getControl()
Control instance that should be used to input data for the
field |
Message |
ImageField.getCutline()
Gets the cutline
|
String |
ImageField.getCutlineText()
Gets the cutline text
|
String |
UserLinkField.getDataObjectClassName()
DataObjectClassName used as a parameter of generated inquiry link url.
|
String |
RoleLinkField.getDataObjectClassName()
DataObjectClassName used as a parameter of generated inquiry link url.
|
String |
GroupLinkField.getDataObjectClassName()
DataObjectClassName used as a parameter of generated inquiry link url
|
String |
AttributeQuery.getDataObjectClassName()
Class name for the data object the query should be performed against
|
DataType |
InputFieldBase.getDataType()
Gets the DataType of this InputField, note that DataType set to be date
when this field is using a date picker with a TextControl and has not otherwise been
explicitly set.
|
Object |
DataFieldBase.getDefaultValue()
Default value for the model property the field points to
|
Class<? extends ValueFinder> |
DataFieldBase.getDefaultValueFinderClass()
Gives Class that should be invoked to produce the default value for the
field
|
List<Object> |
DataFieldBase.getDefaultValues()
Array of default values for the model property the field points to
|
List<PrerequisiteConstraint> |
InputFieldBase.getDependencyConstraints()
List of
PrerequisiteConstraint that apply to this InputField |
String |
DataFieldBase.getDictionaryAttributeName()
Name of the attribute within the data dictionary the attribute field is
associated with
|
String |
DataFieldBase.getDictionaryObjectEntry()
Object entry name in the data dictionary the associated attribute is
apart of
|
String |
ActionField.getDisabledReason() |
String |
ActionField.getErrorCallback() |
String |
InputFieldBase.getExclusiveMin()
The exclusive minimum value for numeric or date field.
|
MethodInvokerConfig |
RemoteFieldsHolder.getFetchingMethodInvoker()
Configuration for the method to invoke for retrieving the list of remotable fields
|
String |
RemoteFieldsHolder.getFetchingMethodToCall()
Name of the method to invoke for retrieving the list of remotable fields
|
Label |
FieldBase.getFieldLabel() |
String |
ActionField.getFocusOnIdAfterSubmit() |
Group |
FieldGroup.getGroup()
Group instance that is contained within in the field |
String |
GroupLinkField.getGroupId()
GroupId key used as a parameter of generated inquiry link url
|
String |
GroupLinkField.getGroupName()
GroupName key used as a parameter of generated inquiry link url
|
String |
GroupLinkField.getGroupNamespaceCode()
GroupNamespaceCode key used as a parameter of generated inquiry link url
|
String |
ImageField.getHeight()
Gets the height of the image
|
Help |
DataFieldBase.getHelp()
Help configuration object for the container
|
String |
InputFieldBase.getHelperText()
Help text that displays under the control and is disclosed on focus.
|
String |
DataFieldBase.getHelpSummary()
Summary help text for the field
|
String |
LinkField.getHref()
Returns the href text of the
Link field. |
Image |
ImageField.getImage()
Retrieves the
Image element wrapped by this field |
String |
InputFieldBase.getInclusiveMax()
The inclusive maximum value for numeric or date field.
|
List<Component> |
MessageField.getInlineComponents() |
Inquiry |
DataFieldBase.getInquiry()
Inquiry widget for the field
|
Message |
InputFieldBase.getInstructionalMessage()
Message field that displays instructional text
|
String |
InputFieldBase.getInstructionalText()
Instructional text that display an explanation of the field usage
|
List<? extends Component> |
FieldGroup.getItems()
List of
Component instances contained in the nested group |
String |
ActionField.getJumpToIdAfterSubmit() |
String |
ActionField.getJumpToNameAfterSubmit() |
String |
FieldBase.getLabel() |
int |
FieldBase.getLabelColSpan() |
List<String> |
FieldBase.getLabelStyleClasses() |
Link |
LinkField.getLink()
Returns the
Link field. |
String |
LinkField.getLinkDialogId()
The id of the DialogGroup to use when the openInDialog property is true for this LinkField's link.
|
String |
LinkField.getLinkText()
Returns the label of the
Link field that will be used to render the label of the link. |
MaskFormatter |
DataFieldBase.getMaskFormatter()
MaskFormatter instance that will be used to mask the field value when
DataField.isApplyMask() is true |
Integer |
InputFieldBase.getMaxLength()
Maximum number of characters the input field value is allowed to have
|
Message |
MessageField.getMessage() |
String |
MessageField.getMessageText() |
String |
ActionField.getMethodToCall()
Delegates
methodToCall property reference to the action. |
Integer |
InputFieldBase.getMinLength()
Minimum number of characters the input field value needs to be
|
List<MustOccurConstraint> |
InputFieldBase.getMustOccurConstraints() |
String |
ActionField.getNavigateToPageId()
Delegates to
Action.getNavigateToPageId(). |
KeyValuesFinder |
InputFieldBase.getOptionsFinder()
Instance of
KeyValuesFinder that should be invoked to
provide a List of values the field can have. |
Class<? extends KeyValuesFinder> |
InputFieldBase.getOptionsFinderClass()
Get the class of the optionsFinder being used by this InputField
|
List<Component> |
InputFieldBase.getPostInputAddons()
List of components that will be grouped with the input field control to form an input group.
|
List<String> |
InputFieldBase.getPostInputCssClasses()
List of CSS classes that will be applied to the span that wraps the post input components.
|
String |
ActionField.getPreSubmitCall() |
String |
UserLinkField.getPrincipalId()
PrincipalId key used as a parameter of generated inquiry link url.
|
String |
UserLinkField.getPrincipalName()
PrincipalName key used as a parameter of generated inquiry link url.
|
ProgressBar |
ProgressBarField.getProgressBar()
The ProgressBar to be shown for this field
|
PropertyEditor |
DataFieldBase.getPropertyEditor()
Performs formatting of the field value for display and then converting the value back to its
expected type from a string
|
String |
RemoteFieldsHolder.getPropertyName()
Path to the Map property that the translated fields bind to
|
String |
DataFieldBase.getPropertyName()
Name of the property (relative to the parent object) the component binds
to
|
List<String> |
DataFieldBase.getPropertyNamesForAdditionalDisplay()
List of property names whose values should be displayed read-only under this field
|
Map<String,String> |
AttributeQuery.getQueryFieldMapping()
Configures the query parameters by mapping fields in the view
to properties on the data object class for the query
|
List<String> |
AttributeQuery.getQueryMethodArgumentFieldList()
List of field names that should be passed as arguments to the query method
|
MethodInvokerConfig |
AttributeQuery.getQueryMethodInvokerConfig()
Configures the query method target class/object and method name
|
String |
AttributeQuery.getQueryMethodToCall()
Configures the name of the method that should be invoked to perform
the query
|
QuickFinder |
InputFieldBase.getQuickfinder()
Lookup finder widget for the field
|
String |
DataFieldBase.getReadOnlyDisplayReplacement()
Returns the alternate display value
|
String |
DataFieldBase.getReadOnlyDisplayReplacementPropertyName()
Returns the alternate display attribute name to be displayed when the field is readonly.
|
String |
DataFieldBase.getReadOnlyDisplaySuffix()
Returns the additional display value.
|
String |
DataFieldBase.getReadOnlyDisplaySuffixPropertyName()
Returns the additional display attribute name to be displayed when the field is readonly
|
String |
DataFieldBase.getReadOnlyListDelimiter()
The readOnlyListDelimiter is used to set the delimiter used when "DELIMITED" type is set for
readOnlyListDisplayType
|
String |
DataFieldBase.getReadOnlyListDisplayType()
Gets the readOnlyListDisplayType.
|
String |
ActionField.getRefreshId() |
Boolean |
InputFieldBase.getRequired()
Indicates whether the component is required
|
Map<String,String> |
AttributeQuery.getReturnFieldMapping()
Maps properties from the result object of the query to
fields in the view
|
String |
AttributeQuery.getReturnMessageStyleClasses()
CSS Style classes that should be applied to the return message.
|
String |
AttributeQuery.getReturnMessageText()
Message text to display along with the query result
|
String |
RoleLinkField.getRoleId()
RoleId key used as a parameter of generated inquiry link url.
|
String |
RoleLinkField.getRoleName()
RoleName key used as a parameter of generated inquiry link url.
|
String |
RoleLinkField.getRoleNamespaceCode()
RoleNamespaceCode key used as a parameter of generated inquiry link url.
|
String |
FieldBase.getShortLabel() |
SimpleConstraint |
InputFieldBase.getSimpleConstraint() |
String |
LinkField.getSortAs() |
String |
DataFieldBase.getSortAs()
Sets the sort type if this field is used within a collection
|
List<String> |
AttributeQuery.getSortPropertyNames()
List of property names to sort the query results by.
|
String |
ImageField.getSource()
Retrieves the URL the image wrapped by this field
|
String |
ActionField.getSuccessCallback() |
Suggest |
InputFieldBase.getSuggest()
Suggest box widget for the input field
|
String |
LinkField.getTarget()
Returns the target of the
Link field that will be used to specify where to open the href. |
FieldValidationMessages |
InputFieldBase.getValidationMessages()
Field that contains the messages (errors) for the input field.
|
ValidCharactersConstraint |
InputFieldBase.getValidCharactersConstraint() |
String |
ImageField.getWidth()
Gets the width of the image
|
boolean |
DataFieldBase.isAddHiddenWhenReadOnly()
Indicates the field should be read-only but also a hidden should be generated for the field
|
boolean |
InputFieldBase.isAjaxInlineEdit()
When ajaxInlineEdit is enabled, the field will appear as text, and when clicked, the input version of that field
is retrieved from the server; the user will be able to edit that field's value and save that new value.
|
boolean |
ActionField.isAjaxSubmit() |
boolean |
DataFieldBase.isApplyMask()
Indicates whether the value for the field should be masked (or partially masked) on display
|
boolean |
ImageField.isCaptionHeaderAboveImage()
Gets boolen of whether the caption header is above the image
|
boolean |
ActionField.isDisableBlocking() |
boolean |
ActionField.isDisabled() |
boolean |
UserLinkField.isDisableLink()
True if this fields link is disabled, false otherwise.
|
boolean |
RoleLinkField.isDisableLink()
True if this fields link is disabled, false otherwise.
|
boolean |
GroupLinkField.isDisableLink()
True if this fields link is disabled, false otherwise.
|
boolean |
InputFieldBase.isDisableNativeAutocomplete()
Indicates whether the browser autocomplete functionality should be disabled for the
input field (adds autocomplete="off")
|
Boolean |
FieldSecurity.isEditInLineAuthz()
Indicates whether the field has edit in line authorization and KIM should be consulted
|
Boolean |
FieldBase.isEditInLineAuthz() |
boolean |
InputFieldBase.isEnableAutoDirectInquiry()
Indicates whether direct inquiries should be automatically set when a relationship for
the field's property is found
|
boolean |
InputFieldBase.isEnableAutoQuickfinder()
Indicates whether quickfinders should be automatically set when a relationship for the field's
property is found
|
boolean |
DataFieldBase.isEscapeHtmlInPropertyValue()
Returns true if HTML escape allowed for this field
|
boolean |
InputFieldBase.isInlineEdit()
When inlineEdit is enabled, the field will appear as text, and when clicked the user will be able to edit that
field's value and save that new value.
|
boolean |
FieldBase.isLabelLeft()
The label for this field will be positioned to the left of the field content, when true.
|
boolean |
FieldBase.isLabelRendered() |
boolean |
DataFieldBase.isMultiLineReadOnlyDisplay()
Returns true if this field is of type
TextAreaControl. |
boolean |
RoleLinkField.isNamespaceInLinkText()
True if namespaceCode is to be included in this links linkText, false otherwise.
|
boolean |
GroupLinkField.isNamespaceInLinkText()
True if namespaceCode is to be included in this links linkText, false otherwise.
|
boolean |
LinkField.isOpenInDialog()
Indicates whether the link's URL should be opened in a dialog.
|
boolean |
ActionField.isPerformClientSideValidation() |
boolean |
ActionField.isPerformDirtyValidation() |
boolean |
DataFieldBase.isRenderInfoMessageSpan()
When true, render the info message span which contains can contain additional information
about the field (used by Field Query functionality)
|
boolean |
InputFieldBase.isRenderInputAddonGroup()
Forces rendering of the input group div around the control.
|
boolean |
DataFieldBase.isRenderMarkerIconSpan()
When true, render the marker icon span to show icons related to the field (used by CompareFieldCreateModifier on
maintenance documetnts to mark editted fields)
|
boolean |
AttributeQuery.isRenderNotFoundMessage()
Indicates whether a message should be added to the query result
object and displayed when the query return object is null
|
boolean |
InputFieldBase.isUppercaseValue()
Perform uppercase flag for this field to force input to uppercase.
|
Boolean |
FieldSecurity.isViewInLineAuthz()
Indicates whether the field has view in line unmask authorization and KIM should be consulted
|
Boolean |
FieldBase.isViewInLineAuthz() |
boolean |
InputFieldBase.isWidgetInputOnly()
Indicates indicates whether the field can only be updated through a widget
widgetInputOnly behaves similar to ReadOnly with the exception that the value of the input field
can be changed via the associated widget (e.g.
|
| Modifier and Type | Method and Description |
|---|---|
String |
TableLayoutManagerBase.getActionColumnPlacement()
Indicates the actions column placement
|
FieldGroup |
TableLayoutManagerBase.getActionFieldPrototype()
FieldGroup instance to serve as a prototype for the actions column. |
List<String> |
LayoutManagerBase.getAdditionalCssClasses() |
Group |
StackedLayoutManagerBase.getAddLineGroup()
Returns the parent
CollectionLayoutManagerBase's add line group |
List<ColumnCalculationInfo> |
TableLayoutManagerBase.getColumnCalculations()
Gets the column calculations.
|
Map<String,String> |
TableLayoutManagerBase.getConditionalRowCssClasses() |
Map<String,Object> |
LayoutManagerBase.getContext()
Context map for the lifecycle element.
|
List<String> |
LayoutManagerBase.getCssClasses() |
int |
CssGridLayoutManager.getDefaultItemSize()
The default "cell" size to use for this layout - this converts to medium size
(max setting, and the default, is 12)
|
Action |
TableLayoutManagerBase.getExpandDetailsActionPrototype()
The Action prototype used for the row details expand link.
|
CssGridSizes |
CssGridLabelColumnLayoutManager.getFieldColumnSizes()
CssGridSizes that will be used by every field in this layout, unless the field itself has cssGridSizes
explicitly set; note that this OVERRIDES any framework automation set by numberOfLabelColumns for field sizes.
|
String |
TableLayoutManagerBase.getGroupingPrefix()
Get the groupingPrefix.
|
List<String> |
TableLayoutManagerBase.getGroupingPropertyNames()
Gets the list of property names to use for grouping.
|
String |
TableLayoutManagerBase.getGroupingTitle()
Get the groupingTitle.
|
Label |
TableLayoutManagerBase.getGroupTotalLabelPrototype()
The groupTotal label to use when renderOnlyLeftTotalLabels is TRUE.
|
Label |
TableLayoutManagerBase.getHeaderLabelPrototype()
Label instance to use as a prototype for creating the tables header fields. |
Set<String> |
TableLayoutManagerBase.getHiddenColumns()
Gets a set of property names defining hidden columns.
|
String |
LayoutManagerBase.getId()
The unique id (within a given tree) for the element.
|
String |
BoxLayoutManager.getItemStyle()
Used by the render to set the style on the span element that wraps the
item.
|
List<String> |
BoxLayoutManager.getItemStyleClasses()
List of style classes that should be applied to each span that wraps the item in the layout
|
String |
CssGridLabelColumnLayoutManager.getLabelColumnCssClass()
The css class to use on the label column's div "cells"
|
CssGridSizes |
CssGridLabelColumnLayoutManager.getLabelColumnSizes()
CssGridSizes that will be used by every label in this layout, unless the label itself has cssGridSizes
explicitly set; note that this OVERRIDES any framework automation set by numberOfLabelColumns for label sizes.
|
int |
CssGridSizes.getLgOffset()
The offset (amount "pushed over") the div will have before the Component content at a large screen
size (large desktop); this can be set to 0 to override previous screen size offsets.
|
int |
CssGridSizes.getLgSize()
The size this Component's "cell" div will take up at a large screen size (large desktop).
|
Group |
StackedLayoutManagerBase.getLineGroupPrototype()
Group instance that is used as a prototype for creating the collection
line groups.
|
int |
CssGridSizes.getMdOffset()
The offset (amount "pushed over") the div will have before the Component content at a medium screen
size (desktop), this can be set to 0 to override previous screen size offsets.
|
int |
CssGridSizes.getMdSize()
The size this Component's "cell" div will take up at a medium screen size (desktop).
|
int |
TableLayoutManagerBase.getNumberOfColumns()
Indicates the number of columns that should make up one row of data.
|
int |
GridLayoutManagerBase.getNumberOfColumns()
Indicates the number of columns that should make up one row of data
|
int |
TableLayoutManagerBase.getNumberOfDataColumns() |
int |
CssGridLabelColumnLayoutManager.getNumberOfLabelColumns()
The number of label columns used in this layout
|
UifConstants.Orientation |
BoxLayoutManager.getOrientation()
Indicates whether the components should be rendered in a horizontal or
vertical column
|
String |
BoxLayoutManager.getPadding()
Amount of separation between each item
|
Label |
TableLayoutManagerBase.getPageTotalLabel()
The pageTotal label to use when renderOnlyLeftTotalLabels is TRUE for total.
|
List<PropertyReplacer> |
LayoutManagerBase.getPropertyReplacers()
List of
PropertyReplacer instances that will be
evaluated during the view lifecycle to conditional set properties on the
LayoutManager based on expression evaluations |
RichTable |
TableLayoutManagerBase.getRichTable()
Widget associated with the table to add functionality such as sorting, paging, and export
|
List<String> |
TableLayoutManagerBase.getRowCssClasses()
List of styles for each row.
|
List<String> |
GridLayoutManagerBase.getRowCssClasses()
List of styles for each row.
|
List<String> |
TableLayoutManagerBase.getRowDataAttributes()
List of data attributes for each row.
|
List<String> |
GridLayoutManagerBase.getRowDataAttributes()
List of data attributes for each row.
|
Group |
TableLayoutManagerBase.getRowDetailsGroup()
The row details info group to use when using a TableLayoutManager with the a richTable.
|
Field |
TableLayoutManagerBase.getSequenceFieldPrototype()
Field instance to serve as a prototype for the sequence field. |
String |
TableLayoutManagerBase.getSequencePropertyName()
Attribute name to use as sequence value.
|
int |
CssGridSizes.getSmOffset()
The offset (amount "pushed over") the div will have before the Component content at a small screen
size (tablet).
|
int |
CssGridSizes.getSmSize()
The size this Component's "cell" div will take up at a small screen size (tablet).
|
Set<String> |
TableLayoutManagerBase.getSortableColumns()
Gets a set of property names defining sortable columns.
|
List<Group> |
StackedLayoutManagerBase.getStackedGroups()
Final
List of Groups to render for the collection |
String |
LayoutManagerBase.getStyle()
CSS style string to be applied to the area (div) the layout manager
generates for the items
|
List<String> |
StackedLayoutManagerBase.getSummaryFields()
List of attribute names from the collection line class that should be
used to build the line summary.
|
String |
StackedLayoutManagerBase.getSummaryTitle()
Text to appears in the header for each collection lines Group.
|
String |
LayoutManagerBase.getTemplate()
The path to the JSP file that should be called to invoke the layout
manager
|
String |
LayoutManagerBase.getTemplateName()
The name for which the template can be invoked by
|
Action |
TableLayoutManagerBase.getToggleAllDetailsAction()
The toggleAllDetailsAction action component used to toggle all row details open/closed.
|
Label |
TableLayoutManagerBase.getTotalLabel()
The total label to use when renderOnlyLeftTotalLabels is TRUE for total.
|
Group |
StackedLayoutManagerBase.getWrapperGroup()
Group that will 'wrap' the generated collection lines so that they have a different layout from the general
stacked layout
|
int |
CssGridSizes.getXsSize()
The size this Component's "cell" div will take up at an extra small screen size (phone).
|
boolean |
TableLayoutManagerBase.isAjaxDetailsRetrieval()
If true, when a row details open action is performed, it will get the details content from
the server the first time it is opened.
|
boolean |
TableLayoutManagerBase.isApplyAlternatingRowStyles()
Indicates whether alternating row styles should be applied.
|
boolean |
GridLayoutManagerBase.isApplyAlternatingRowStyles()
Indicates whether alternating row styles should be applied
|
boolean |
TableLayoutManagerBase.isApplyDefaultCellWidths()
Indicates whether the manager should default the cell widths.
|
boolean |
GridLayoutManagerBase.isApplyDefaultCellWidths()
Indicates whether the manager should default the cell widths
|
Boolean |
TableLayoutManagerBase.isAutoTruncateColumns()
Indicates whether the column text should be truncated when the table cell
is to small to display the text without wrapping.
|
boolean |
TableLayoutManagerBase.isGenerateAutoSequence()
Indicates whether the sequence field should be generated with the current line number
|
boolean |
ListLayoutManager.isOrderedList()
If true, this list layout is an ordered list (ol).
|
boolean |
GridLayoutManagerBase.isRenderAlternatingHeaderColumns()
Indicates whether header columns (th for tables) should be rendered for
every other item (alternating)
|
boolean |
GridLayoutManagerBase.isRenderFirstRowHeader()
Indicates whether the first row of items rendered should all be rendered as table header (th) cells
|
boolean |
StackedLayoutManagerBase.isRenderLineActionsInHeader()
When true, actions specified in lineActions will appear to the very right of the header
(appears in the corner of the stacked item) by placing the actions in the Header's rightGroup.
|
boolean |
StackedLayoutManagerBase.isRenderLineActionsInLineGroup()
Flag that indicates whether actions will be added in the same group as the line items instead of in the
footer of the line group
|
boolean |
TableLayoutManagerBase.isRenderOnlyLeftTotalLabels()
When true, labels for the totals fields will only appear in the left most column.
|
boolean |
GridLayoutManagerBase.isRenderRowFirstCellHeader()
Indicates whether the first cell of each row should be rendered as a header cell (th)
|
boolean |
TableLayoutManagerBase.isRenderSequenceField()
Indicates whether the sequence field should be rendered for the collection
|
boolean |
TableLayoutManagerBase.isRepeatHeader()
Indicates whether the header should be repeated before each collection row.
|
boolean |
TableLayoutManagerBase.isRowDetailsOpen()
If true, all details will be opened by default when the table loads.
|
boolean |
TableLayoutManagerBase.isSeparateAddLine()
Indicates whether the add line should be rendered in a separate group, or as part of the
table (first line)
|
boolean |
TableLayoutManagerBase.isShowGroupTotal()
Gets showGroupTotal.
|
boolean |
TableLayoutManagerBase.isShowPageTotal()
Gets showTotal.
|
boolean |
TableLayoutManagerBase.isShowToggleAllDetails()
If true, the toggleAllDetailsAction will be shown.
|
boolean |
TableLayoutManagerBase.isShowTotal()
Gets showTotal.
|
boolean |
TableLayoutManagerBase.isSuppressLineWrapping()
Indicates whether the number of columns for the table data should match
the number of fields given in the container's items list (so that each
field takes up one column without wrapping), this overrides the configured
numberOfColumns.
|
boolean |
GridLayoutManagerBase.isSuppressLineWrapping()
Indicates whether the number of columns for the table data should match
the number of fields given in the container's items list (so that each
field takes up one column without wrapping), this overrides the configured
numberOfColumns
|
boolean |
TableLayoutManagerBase.isUseShortLabels()
Indicates whether the short label for the collection field should be used as the table header
or the regular label
|
void |
CssGridSizes.setOffsets(int[] offsets)
Convenience setter for offsets which takes in 3 integers in this order: smOffset, mdOffset, lgOffset
|
void |
CssGridSizes.setSizes(int[] sizes)
Convenience setter for sizes which takes in 4 integers in this order: xsSize, smSize, mdSize, lgSize
|
| Modifier and Type | Method and Description |
|---|---|
Group |
CollectionLayoutManagerBase.getAddLineGroup()
Group for rendering the add line when separate (always the case for stacked layout, and a configuration
for table layout).
|
Pager |
CollectionLayoutManagerBase.getPagerWidget()
Widget used to page the collection.
|
Field |
CollectionLayoutManagerBase.getSelectFieldPrototype()
Field instance that serves as a prototype for creating the select field on each line when
CollectionGroup.isIncludeLineSelectionField() is
true. |
FieldGroup |
CollectionLayoutManagerBase.getSubCollectionFieldGroupPrototype()
Field group instance that is used as a prototype for creating the sub-collection field groups.
|
| Modifier and Type | Method and Description |
|---|---|
String |
ComparableInfo.getBindingObjectPath()
Returns the path (from the form) for the object to compare to
|
String |
ComparableInfo.getComparableId()
Specifies an id suffix to use for the generated comparison fields
|
List<ComparableInfo> |
CompareFieldCreateModifier.getComparables()
List of
ComparableInfo instances the compare fields should
be generated for |
Component |
ComponentConvertModifier.getComponentReplacementPrototype()
Prototype for the component replacement
|
Class<? extends Component> |
ComponentConvertModifier.getComponentTypeToReplace()
Type of component that should be replaced with an instance of the
component prototype
|
int |
CompareFieldCreateModifier.getDefaultOrderSequence()
Indicates the starting integer sequence value to use for
ComparableInfo instances that do not have the order property
set |
Header |
CompareFieldCreateModifier.getHeaderFieldPrototype()
Prototype instance to use for creating the
HeaderField for
each group of comparison fields (if generateCompareHeaders is true) |
String |
ComparableInfo.getHeaderText()
Text that should display on the header for the compare group
|
int |
ComponentModifierBase.getOrder() |
int |
ComparableInfo.getOrder()
Sets the order value that will be used to determine where the compare
group should be placed in relation to the other compare groups
|
String |
ComponentModifierBase.getRunCondition() |
String |
ComponentModifierBase.getRunPhase() |
boolean |
ComparableInfo.isCompareToForFieldRender()
Indicates whether this comparable group's field values should include the
renderOnComparableModifier context variable when this comparable
is used to modify an existing component |
boolean |
ComparableInfo.isCompareToForValueChange()
Indicates whether this comparable group's field values should be compared
to when highlighting changes of values between comparables (versions)
|
boolean |
CompareFieldCreateModifier.isGenerateCompareHeaders()
Indicates whether a
HeaderField should be created for each
group of comparison fields |
boolean |
ComparableInfo.isHighlightValueChange()
Indicates whether the fields in this comparable group should be
highlighted if their values defer from the comparable group marked for
comparison
|
boolean |
ComparableInfo.isReadOnly()
Indicates whether the compare group should be read-only
|
| Modifier and Type | Method and Description |
|---|---|
String |
UrlInfo.getBaseUrl()
The base url value (the value that comes before other properties).
|
String |
ColumnCalculationInfo.getCalculationFunctionExtraData()
This specifies extra data to be sent to the calculation function.
|
String |
ColumnCalculationInfo.getCalculationFunctionName()
Gets the js calculationFunctionName.
|
Integer |
ColumnCalculationInfo.getColumnNumber()
Gets the column number.
|
String |
UrlInfo.getControllerMapping()
The controllerMapping for the url (string that represents the controllerMapping path appended to baseUrl)
|
String |
UrlInfo.getFormKey()
FormKey representing the key of the form data to retrieve
|
MessageField |
ColumnCalculationInfo.getGroupTotalFieldPrototype()
Gets the groupTotalFieldPrototype.
|
String |
UrlInfo.getHref()
Get the href value for this url object.
|
String |
UifKeyValue.getKey() |
String |
UifOptionGroupLabel.getLabel()
Get the label for the option group.
|
UrlInfo |
UifKeyValueLocation.getLocation()
Get the url object representing the location
|
String |
UrlInfo.getMethodToCall()
MethodToCall representing the methodToCall on the controller (default base bean value is 'start')
|
BreadcrumbItem |
ParentLocation.getPageBreadcrumbItem()
The pageBreadcrumbItem to use for the parent location view breadcrumb.
|
String |
UrlInfo.getPageId()
PageId representing the page of the view to retrieve by id
|
MessageField |
ColumnCalculationInfo.getPageTotalField()
Gets the pageTotalField.
|
String |
ParentLocation.getParentPageLabel()
The parentPageLabel is the text used for breadcrumbItem label of the parent page.
|
UrlInfo |
ParentLocation.getParentPageUrl()
The parentPageUrl representing a page url that is the parent of this View.
|
String |
ParentLocation.getParentViewLabel()
The parentViewLabel is the text used for breadcrumbItem label of the parent view.
|
UrlInfo |
ParentLocation.getParentViewUrl()
The parentViewUrl representing the url that is the parent of this View.
|
String |
ColumnCalculationInfo.getPropertyName()
Get the propertyName of the field to do calculations.
|
Map<String,String> |
UrlInfo.getRequestParameters()
Map of key value pairs that will be appended to the request parameters to pass in any custom data
|
MessageField |
ColumnCalculationInfo.getTotalField()
Gets the totalField.
|
String |
UifKeyValue.getValue() |
BreadcrumbItem |
ParentLocation.getViewBreadcrumbItem()
The viewBreadcrumbItem to use for the parent location view breadcrumb.
|
String |
UrlInfo.getViewId()
ViewId representing the view by id to retrieve
|
String |
UrlInfo.getViewType()
The viewType representing the View's base type
|
boolean |
ColumnCalculationInfo.isCalculateOnKeyUp()
If true, the column is calculated when the user enters a character on each key up.
|
boolean |
ColumnCalculationInfo.isRecalculateTotalClientSide()
When set to false, calculations will not be fired for the totalField client-side.
|
boolean |
ColumnCalculationInfo.isShowGroupTotal()
Gets showGroupTotal.
|
boolean |
ColumnCalculationInfo.isShowPageTotal()
Gets showTotal.
|
boolean |
ColumnCalculationInfo.isShowTotal()
Gets showTotal.
|
| Modifier and Type | Method and Description |
|---|---|
Map<String,Boolean> |
View.getActionFlags()
Map of strings that flag what actions can be taken in the UI.
|
List<String> |
View.getAdditionalCssFiles()
Declares additional CSS files that should be included with the View.
|
List<HeadLink> |
View.getAdditionalHeadLinks()
List of additional link tags that should be included with the View in the html head.
|
Map<String,String> |
FormView.getAdditionalHiddenValues()
Map of property path and values that will get written out as hidden elements.
|
List<MetaTag> |
View.getAdditionalMetaTags()
List of additional meta tags that should be included with the View in the html head tag.
|
List<String> |
View.getAdditionalScriptFiles()
Declares additional script files that should be included with the
View.
|
Group |
View.getApplicationFooter()
Footer for the application containing the view.
|
Header |
View.getApplicationHeader()
Header for the application containing the view.
|
String |
View.getApplicationTitleText()
Title text to be displayed on browser tab.
|
Class<? extends KeyValuesFinder> |
DocumentView.getAttachmentTypesValuesFinderClass()
Gets attachment types values finder classs
|
ViewAuthorizer |
View.getAuthorizer()
Authorizer that should be used for the View instance
|
BreadcrumbItem |
View.getBreadcrumbItem()
The View's breadcrumbItem defines settings for the breadcrumb which appears in the breadcrumb list for this
view.
|
BreadcrumbOptions |
View.getBreadcrumbOptions()
The breadcrumbOptions for this view.
|
Breadcrumbs |
View.getBreadcrumbs()
Breadcrumb widget used for displaying homeward path and history
|
Group |
View.getBuildFooter()
Build footer for the application containing the view.
|
protected ConfigurationService |
ViewAuthorizerBase.getConfigurationService() |
List<String> |
View.getContentContainerCssClasses()
List of CSS style classes that will be applied to a div that wraps the content.
|
List<String> |
ViewTheme.getCssFiles()
List of file paths (relative to the web root) or URLs that will be sourced into the view
as CSS files
|
Class<?> |
MaintenanceDocumentView.getDataObjectClassName()
Class name for the object the maintenance document applies to
|
Class<?> |
InquiryView.getDataObjectClassName()
Class name for the object the inquiry applies to
|
String |
View.getDefaultBindingObjectPath()
For View types that work primarily with one nested object of
the form (for instance document, or bo) the default binding object path
can be set for each of the views DataBinding components.
|
List<Group> |
View.getDialogs()
Provide a list of dialog groups associated with this view.
|
String |
ViewTheme.getDirectory()
Path to the directory (relative to the web root) that holds the assets for the theme
|
String |
MaintenanceDocumentView.getDocTypeName()
Name for the document type the maintenance document applies to
|
Class<? extends Document> |
DocumentView.getDocumentClass()
Gets the document class
|
Map<String,Boolean> |
View.getEditModes()
Map of edit modes that enabled for the view.
|
String |
View.getEntryPageId()
Specifies what page should be rendered by default.
|
int |
DocumentView.getExplanationDataMaxLength()
Returns the maximum allowed length for explanation notes within the document
|
Map<String,String> |
View.getExpressionVariables()
Map that contains expressions to evaluate and make available as variables
for conditional expressions within the view.
|
Class<?> |
View.getFormClass()
Class of the Form that should be used with the View instance.
|
String |
HistoryEntry.getFormKey() |
String |
FormView.getFormPostUrl()
Specifies the URL the view's form should post to
|
Growls |
View.getGrowls()
Growls widget which sets up global settings for the growls used in this
view and its pages.
|
String |
IframeView.getHref() |
Iframe |
IframeView.getIframe()
The iframe component to be used as the content of this view, nothing needs to be set on this directly if
using the default bean for this View
|
String |
ViewTheme.getImageDirectory()
Path to the directory (relative to the web root) that contains images for the theme
|
List<? extends Component> |
View.getItems()
List of Component instances that are held by
the container |
UrlInfo |
IframeView.getLocation()
Get the url object representing the location
|
String |
MaintenanceDocumentView.getMaintenanceAction()
Indicates what maintenance action (new, edit, copy) was requested.
|
Message |
MessageView.getMessage()
Message component that will be used to display the message (used for styling and so on)
|
String |
MessageView.getMessageText()
Message text to display in the message view.
|
String |
ViewTheme.getMinCssFile()
File path for the minified CSS file
|
List<String> |
ViewTheme.getMinCssSourceFiles()
List of file paths (relative to web root) or URLs that make up the minified CSS file
|
String |
ViewTheme.getMinScriptFile()
File path for the minified JS file
|
List<String> |
ViewTheme.getMinScriptSourceFiles()
List of file paths (relative to web root) or URLs that make up the minified JS file
|
String |
ViewTheme.getMinVersionSuffix()
When the min file paths are not set, the min file names will be generated using the theme
name, version, and the min suffix.
|
String |
ViewTheme.getName()
A name that identifies the view theme, when using the theme builder this should be the same as
the directory (for example, if directory is '/themes/kboot', the theme name will be 'kboot')
|
String |
View.getNamespaceCode()
Namespace code the view should be associated with.
|
Group |
View.getNavigation()
NavigationGroup instance for the View<
|
BlockUI |
View.getNavigationBlockUI() |
Map<String,Class<?>> |
View.getObjectPathToConcreteClassMapping()
Configures the concrete classes that will be used for properties in the
form object graph that have an abstract or interface type.
|
String |
MaintenanceDocumentView.getOldObjectBindingPath()
Gives the binding path to the old object (record being edited) to display
for comparison.
|
PageGroup |
View.getPage()
For single paged views (
View.isSinglePageView(), gives the page
Group the view should render. |
String |
HistoryEntry.getPageId()
The pageId of the page on the view
|
ParentLocation |
View.getParentLocation()
The parentLocation defines urls that represent the parent of a View in a conceptial site hierarchy.
|
String |
View.getPreLoadScript()
Script that is executed at the beginning of page load (before any other script).
|
ViewPresentationController |
View.getPresentationController()
PresentationController that should be used for the View instance.
|
String |
ViewSessionPolicy.getRedirectUrl()
URL the user should be redirected to when a session timeout occurs
|
BlockUI |
View.getRefreshBlockUI() |
List<String> |
ViewTheme.getScriptFiles()
List of file paths (relative to the web root) or URLs that will be sourced into the view
as JS files
|
ViewSessionPolicy |
View.getSessionPolicy()
Configures behavior that should occur when a session timeout occurs on the view.
|
StateMapping |
View.getStateMapping()
Gets the stateMapping.
|
String |
View.getStateObjectBindingPath()
The stateObject's binding path, this will be used along with the StateMapping's statePropertyName to
determine what field in the model state information is stored in for this view.
|
ViewTheme |
View.getTheme()
The theme which contains stylesheets for this view.
|
int |
ViewSessionPolicy.getTimeoutWarningSeconds()
When
ViewSessionPolicy.isEnableTimeoutWarning() is true, the number of seconds before a timeout occurs to give a
warning (default is 120 (2 minutes)) |
String |
HistoryEntry.getTitle()
The title of the view
|
Group |
View.getTopGroup()
TopGroup is an optional group of content that appears above the breadcrumbs and view header.
|
String |
HistoryEntry.getUrl()
The url of this HistoryEntry
|
ViewHelperService |
View.getViewHelperService()
Creates the
ViewHelperService associated with the View |
Class<? extends ViewHelperService> |
View.getViewHelperServiceClass()
Class name of the ViewHelperService that handles the various phases of the Views lifecycle.
|
String |
HistoryEntry.getViewId()
The viewId of the view
|
String |
View.getViewName()
View name provides an identifier for a view within a type.
|
UifConstants.ViewType |
View.getViewTypeName()
View type name the view is associated with the view instance
|
boolean |
DocumentView.isAllowsNoteAttachments()
Gets boolean that indicates if the document view allows note attachments
|
boolean |
DocumentView.isAllowsNoteFYI()
Gets boolean that indicates if the document view allows note FYI
|
boolean |
View.isApplyDirtyCheck()
Indicates whether the form should be validated for dirtyness.
|
boolean |
View.isDisableBrowserCache()
Enables functionality to bust the browsers cache by appending an unique cache key.
|
boolean |
View.isDisableNativeAutocomplete()
Indicates whether the browser autocomplete functionality should be disabled for the
entire form (adds autocomplete="off").
|
boolean |
DocumentView.isDisplayTopicFieldInNotes()
Gets boolean that indicates if the document view displays the topic field in notes
|
boolean |
ViewSessionPolicy.isEnableTimeoutWarning()
Enables the session timeout warning dialog and timeout dialog for the view
|
boolean |
View.isGrowlMessagingEnabled()
Whether to use growls to show messages - info, warning and error
|
boolean |
ViewTheme.isIncludeMinFiles()
Indicates the min files should be sourced into the CSS and JS lists when not in development mode (this
is regardless of whether theme builder is being used or not)
|
boolean |
View.isMergeWithPageItems()
Indicates whether the default sections specified in the page items list
should be included for this view.
|
boolean |
View.isPersistFormToSession()
Indicates whether the form (model) associated with the view should be stored in the user session.
|
boolean |
ViewSessionPolicy.isRedirectToHome()
Indicates when a session timeout occurs the user should be redirect to the application home url
(determined by the configuration parameter 'application.url')
|
boolean |
FormView.isRenderForm()
Indicates whether a Form element should be rendered for the View.
|
boolean |
ViewSessionPolicy.isRenderTimeoutView()
Indicates the user should be shown the timeout message view when a session timeout occurs
|
boolean |
View.isSinglePageView()
Indicates whether the View only has a single page
Group or contains multiple page Group instances.
|
boolean |
View.isStickyApplicationFooter()
If true, the applicationFooter will become sticky (fixed to bottom of window).
|
boolean |
View.isStickyApplicationHeader()
Set to true to make the applicationHeader sticky (fixed to top of window)
|
boolean |
View.isStickyBreadcrumbs()
If true, the breadcrumb widget will be sticky (fixed to top of window).
|
boolean |
View.isStickyFooter()
If true, the view footer will become sticky (fixed to bottom of window).
|
boolean |
View.isStickyHeader()
If true, the ViewHeader for this view will be sticky (fixed to top of window).
|
boolean |
View.isStickyTopGroup()
If true, the top group will be sticky (fixed to top of window).
|
boolean |
View.isSupportsRequestOverrideOfReadOnlyFields()
Indicates whether the view allows read only fields to be specified on the request URL which will
override the view setting.
|
boolean |
View.isTranslateCodesOnReadOnlyDisplay()
Returns whether the current view supports displaying
KualiCode's name as additional display value |
boolean |
View.isUnifiedHeader()
When true, this view will use a unified header - the page header will be omitted and its title will be used
in the ViewHeader supportTitle property (dynamically updated on page change).
|
boolean |
View.isUseLibraryCssClasses()
True if the libraryCssClasses set on components will be output to their class attribute, false otherwise.
|
boolean |
ViewTheme.isUsesThemeBuilder()
Indicates whether the theme has been built (or will be built) using the theme builder and therefore
the theme configuration can be defaulted according to the conventions used by the builder
|
boolean |
FormView.isValidateClientSide()
Indicates whether to perform on-the-fly validation on the client using js
during user data entry.
|
boolean |
FormView.isValidateServerSide()
Indicates whether to perform the validate model phase of the view
lifecycle.
|
| Modifier and Type | Method and Description |
|---|---|
String |
Accordion.getActive()
The active option determines which accordion item is open by default.
|
Map<String,String> |
QuickFinder.getAdditionalLookupParameters()
The additional parameters that were passed to the quickFinder.
|
List<String> |
Suggest.getAdditionalPropertiesToReturn()
List of additional properties to return in the result objects to the plugin's success callback.
|
Map<String,String> |
LocationSuggest.getAdditionalRequestParameters()
AdditionalRequestParameters specify the static(constant) request parameters that should be appended to the url.
|
String |
LocationSuggest.getAdditionalUrlPathPropertyName()
AdditionalUrlPathProperty specifies the property on the retrieved suggestion result that contains a url
appendage
to be appended to the baseUrl when this selection is chosen.
|
String |
RichTable.getAjaxSource()
Specifies a URL for acquiring the table data with ajax
|
int |
Disclosure.getAnimationSpeed()
Gives the speed for the open/close animation, a smaller int will result
in a faster animation
|
Boolean |
QuickFinder.getAutoSearch()
Indicates whether the search should be executed when first rendering the lookup view.
|
String |
Inquiry.getBaseInquiryUrl()
Returns the URL for the inquiry for which parameters will be added
|
String |
QuickFinder.getBaseLookupUrl()
Returns the URL for the lookup for which parameters will be added.
|
String |
LocationSuggest.getBaseUrl()
BaseUrl for the suggestions.
|
String |
BlockUI.getBlockingImageSource()
Path to an image that will be rendered in the blocking overlay
|
String |
Disclosure.getCollapsedIconClass()
Class for the icon that should be rendered when the disclosure group is disclosed.
|
String |
QuickFinder.getDataObjectClassName()
Full class name the lookup should be provided for.
|
String |
Inquiry.getDataObjectClassName()
Full class name the inquiry should be provided for
|
Action |
Inquiry.getDirectInquiryAction()
Action that will be rendered next to the field for a direct inquiry |
String |
RichTable.getEmptyTableMessage()
Returns the text which is used to display text when the table is empty
|
String |
Disclosure.getExpandedIconClass()
Class for the icon that should be rendered when the disclosure group is expanded.
|
String |
Help.getExternalHelpUrl()
The external help Url
|
Map<String,String> |
QuickFinder.getFieldConversions()
Map that determines what properties from a result lookup row (if selected) will be returned to properties on
the calling view.
|
Header |
SyntaxHighlighter.getHeader() |
String |
Scrollpane.getHeight()
Height the content should take up in the group
|
String |
LightBox.getHeight() |
Action |
Help.getHelpAction()
HelpActionField is used for rendering external help
|
HelpDefinition |
Help.getHelpDefinition()
The help definition is used as the key to retrieve the external help Url from the parameter table of
the database
|
Set<String> |
RichTable.getHiddenColumns()
Holds propertyNames for the ones meant to be hidden since columns are visible by default
|
Boolean |
QuickFinder.getHideCriteriaOnSearch()
Indicates whether the lookup criteria should be hidden when a search is executed.
|
String |
LocationSuggest.getHrefPropertyName()
The hrefPropertyName specifies the property on the retrieved suggestion result that contains the href
value (full url).
|
Link |
Inquiry.getInquiryLink()
Link that will be rendered for an inquiry |
Map<String,String> |
Inquiry.getInquiryParameters()
Map that determines what properties from a calling view will be sent to properties on the inquiry data object
|
String |
Suggest.getLabelPropertyName()
Name of the property on the query result object that provides the label for the suggestion.
|
String |
QuickFinder.getLookupCollectionId()
For the case of multi-value lookup, indicates the collection id that should be populated with
the return results.
|
String |
QuickFinder.getLookupCollectionName()
For the case of multi-value lookup, indicates the collection that should be populated with
the return results.
|
String |
QuickFinder.getLookupDialogId()
The id of the DialogGroup to use when the openInDialog property is true.
|
Map<String,String> |
QuickFinder.getLookupParameters()
Map that determines what properties from a calling view will be sent to properties on that are rendered
for the lookup view's search fields (they can be hidden).
|
Boolean |
QuickFinder.getMultipleValuesSelect()
Indicates whether the invoked lookup view should allow multiple values to be selected and returned.
|
int |
RichTable.getNestedLevel()
The nestedLevel property represents how many collection tables deep this particular table is
|
String |
LocationSuggest.getObjectIdPropertyName()
The objectIdPropertyName that represents the key for getting the object as a request parameter.
|
String |
SyntaxHighlighter.getPluginCssClass()
The class that will be set on the pre tags
|
UifConstants.Position |
Tabs.getPosition()
The position the tabs will appear related to the group, options are TOP, BOTTOM, RIGHT, or LEFT
|
String |
Growls.getPosition()
The position for the growls to appear in the window
There are five options available: top-left, top-right, bottom-left, bottom-right, center.
|
Action |
QuickFinder.getQuickfinderAction()
Action component that is used to rendered for the field for invoking the quickfinder action (bringing up the
lookup).
|
String |
QuickFinder.getReadOnlyLookupFields()
Comma delimited String of property names on the lookup view that should be read only.
|
String |
QuickFinder.getReferencesToRefresh()
List of property names on the model that should be refreshed when the lookup returns.
|
Boolean |
QuickFinder.getRenderCriteriaActions()
Indicates whether the criteria actions (footer) should be rendered on the invoked lookup view.
|
Boolean |
QuickFinder.getRenderLookupCriteria()
Indicates whether the lookup criteria (search group) should be enabled on the invoked lookup view.
|
Boolean |
QuickFinder.getRenderMaintenanceLinks()
Indicates whether the maintenance action links should be rendered for the invoked lookup view.
|
Boolean |
QuickFinder.getRenderResultActions()
Indicates whether the maintenance actions (or others) are rendered on the invoked lookup view.
|
Boolean |
QuickFinder.getRenderReturnLink()
Indicates whether the return links for lookup results should be rendered.
|
Map<String,String> |
LocationSuggest.getRequestParameterPropertyNames()
RequestParameterPropertyNames specify the properties that should be included in the request parameters.
|
Set<String> |
RichTable.getSortableColumns()
Holds the propertyNames for columns that are to be sorted
|
String |
SyntaxHighlighter.getSourceCode()
The text to render with syntax highlighting
|
List<Object> |
Suggest.getSuggestOptions()
When
Suggest.isRetrieveAllSuggestions() is true, this list provides the full list of suggestions |
AttributeQuery |
Suggest.getSuggestQuery()
Attribute query instance the will be executed to provide
the suggest options
|
String |
Tabs.getTabContentClass()
Css class for the div which wraps the tab content panels, the default bean defines this as "tabs-content"
|
String |
Tabs.getTabNavClass()
Css class for the ul list of tab navigation links, the default bean defines this as "nav nav-tabs"
|
int |
Growls.getTimeShown()
The time growls are shown in milliseconds
|
String |
Tooltip.getTooltipContent()
Plain text or HTML string that will be used to render the tooltip div
|
String |
Help.getTooltipHelpContent()
TooltipHelpContent
|
String |
Suggest.getValuePropertyName()
Name of the property on the query result object that provides
the options for the suggest, values from this field will be
collected and sent back on the result to provide as suggest options.
|
String |
QuickFinder.getViewName()
When multiple target lookup views exists for the same data object class, the view name can be set to
determine which one to use.
|
String |
Inquiry.getViewName()
When multiple target inquiry views exists for the same data object class, the view name can be set to
determine which one to use
|
String |
LightBox.getWidth() |
boolean |
LightBox.isAddAppParms()
Indicates that the light box link should have application parameters added to it.
|
boolean |
Disclosure.isAjaxRetrievalWhenOpened()
When true, the group content will be retrieved when the disclosure is opened
|
boolean |
SyntaxHighlighter.isAllowCopy()
Indicates if the ZeroClipboard copy functionality must be added
|
boolean |
Disclosure.isDefaultOpen()
Indicates whether the group should be initially open
|
boolean |
RichTable.isDisableTableSort()
Returns true if sorting is disabled
|
boolean |
Breadcrumbs.isDisplayBreadcrumbsWhenOne()
If false, breadcrumbs will not be displayed if only one breadcrumb is
going to be shown, this improves visual clarity of the page
|
boolean |
Inquiry.isEnableDirectInquiry()
Indicates that the direct inquiry will not be rendered
|
boolean |
RichTable.isForceAoColumnDefsOverride()
If set to true and the aoColumnDefs template option is explicitly defined in templateOptions,
those aoColumnDefs will be used for this table.
|
boolean |
RichTable.isForceLocalJsonData()
If true, the table will automatically use row JSON data generated by this widget
|
boolean |
Tooltip.isOnFocus()
Indicates the tooltip should be triggered by focus/blur
|
boolean |
Tooltip.isOnMouseHover()
Indicates the tooltip should be triggered by mouse hover
|
boolean |
QuickFinder.isOpenInDialog()
True if the quickfinder's lookup should be opened in a dialog; true is the default setting for the
bean.
|
boolean |
Disclosure.isRenderIcon()
Indicates whether the expanded and collapsed icons should be rendered for the disclosure.
|
boolean |
Suggest.isRetrieveAllSuggestions()
Indicates whether all suggest options should be retrieved up front and provide to the suggest
widget as options locally
|
boolean |
QuickFinder.isReturnByScript()
Indicates whether the lookup return should occur through script, or by refresing the page (making server
request).
|
boolean |
Suggest.isReturnFullQueryObject()
When set to true the results of a query method will be sent back as-is (in translated form) with all properties
intact.
|
boolean |
SyntaxHighlighter.isShowCopyConfirmation()
Indicates if a confirmation dialog must be shown after copy action
|
boolean |
RichTable.isShowExportOption()
Returns true if export option is enabled
|
boolean |
Growls.isSticky()
If true, the growl will stick to the page until the user dismisses it
|
boolean |
Breadcrumbs.isUsePathBasedBreadcrumbs()
If set to true, the breadcrumbs on the View will always be path-based (history backed)
|
Copyright © 2005–2018 The Kuali Foundation. All rights reserved.