ColumnSettings (Technia Value Components (2024.3.0) API Documentation

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

MutableColumnSettings
```
public interface ColumnSettings
extends java.io.Serializable
```
Provides a convenient way to access supported/built-in settings on a column.
Custom settings can be obtained through:
Since:

5.2.1

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAccessExpression()` Returns the Access Expression setting.
`java.lang.String`	`getAccessFunction()` Returns the Access Function setting.
`java.lang.String`	`getAccessMask()` Returns the Access Mask setting.
`java.lang.String`	`getAccessProgram()` Returns the Access Program setting.
`java.lang.String`	`getAdminType()` Returns the Admin Type setting.
`boolean`	`getAllowedInCharts()` Returns the Allowed In Charts setting.
`boolean`	`getAllowMultipleEdit()` Returns the Allow Multiple Edit setting.
`boolean`	`getAllowShowMore()` Returns the Allow Show More setting.
`java.lang.String`	`getAlternateOIDExpression()` Returns the Alternate OID Expression setting.
`boolean`	`getAlternateOIDExpressionUsesBusinessObject()` Returns the Alternate OID Expression Uses Business Object setting.
`java.lang.String`	`getAlternatePolicyExpression()` Returns the Alternate Policy Expression setting.
`java.lang.String`	`getAlternateTypeExpression()` Returns the Alternate Type Expression setting.
`java.lang.String`	`getAutoCompleteHandler()` The AutoCompleteHandler to use.
`java.lang.String`	`getAutoCompleteSettings()` Settings for the autocomplete.
`int`	`getCalculationDecimalPrecision()` Returns the Calculation Decimal Precision setting.
`java.lang.String`	`getCardID()` Returns the Card ID setting.
`java.lang.String`	`getCardLoadScript()` Returns the Card Load Script setting.
`boolean`	`getCardReloadable()` Returns the Card Reloadable setting.
`java.lang.String`	`getCardTitle()` Returns the Card Title setting.
`int`	`getCardWidth()` Returns the Card Width setting.
`java.lang.String`	`getCellEditableExpression()` Returns the Cell Editable Expression setting.
`java.lang.String`	`getCellRendererClass()` Returns the Cell Renderer Class setting.
`java.lang.String`	`getCellShowableExpression()` Returns the Cell Showable Expression setting.
`boolean`	`getCheckFromAccess()` Returns the Check From Access setting.
`boolean`	`getCheckToAccess()` Returns the Check To Access setting.
`java.lang.String`	`getColumnIcon()` Returns the Column Icon setting.
`java.lang.String`	`getColumnOrientation()` Returns the Orientation setting.
`int`	`getColumns()` Returns the Columns setting.
`java.lang.String`	`getColumnType()` Returns the Column Type setting.
`int`	`getColumnWidth()` Returns the Column Width setting.
`java.lang.String`	`getDataHandlerClass()` Returns the name of the DataHandler class.
`java.lang.String`	`getDecimalFormat()` Returns the Decimal format.
`int`	`getDecimalFormatScale()` Returns the Decimal format multiplier.
`java.lang.String`	`getDescription()` Returns the Description setting.
`java.lang.String`	`getDisplayFormat()` Returns the Display Format setting.
`java.lang.String`	`getDisplaySeparator()` Returns the Display Separator setting.
`java.lang.String`	`getEditableExpression()` Returns the Editable Expression setting.
`java.lang.String`	`getEditableFunction()` Returns the Editable Function setting.
`java.lang.String`	`getEditableMask()` Returns the Editable Mask setting.
`java.lang.String`	`getEditableProgram()` Returns the Editable Program setting.
`java.lang.String`	`getExcelDataFormat()`
`boolean`	`getFilter()` Returns the Filter setting.
`java.lang.String`	`getFinderFieldClass()` Returns the custom finder class.
`java.lang.String`	`getFinderLabel()` Returns the label of the finder field.
`java.lang.String`	`getFinderOperator()` Returns the operator of finder field.
`int`	`getFinderOrder()` Return the order in which to render the finder field.
`java.lang.String`	`getFinderRendererClass()` Returns the finder renderer class.
`java.lang.String`	`getFinderTooltip()` Return the tooltip of the finder field.
`java.lang.String`	`getFinderType()` Returns the type of finder field, e.g.
`java.lang.String`	`getFormat()` Returns the Format setting.
`java.lang.String`	`getFunction()` Returns the Function setting.
`java.lang.String`	`getGroupCalculation()` Returns the calculation(s) to be shown in group cell setting.
`java.lang.String`	`getGroupHeader()` Returns the Group Header setting.
`int`	`getHeaderRotationAngle()`
`java.lang.String`	`getIconClass()`
`java.lang.String`	`getImageSize()` Returns the Image Size setting.
`java.lang.String`	`getInputType()` Returns the Input Type setting.
`int`	`getLeftTextLength()` Returns the length of left text which will be visible when truncate direction of column is center
`boolean`	`getNoWrap()` Returns the No Wrap setting.
`boolean`	`getNoWrapOnPrint()` Returns the No Wrap On Print setting.
`boolean`	`getPopupModal()` Returns the Popup Modal setting.
`boolean`	`getPreserveOutput()` Returns the Preserve Output setting.
`java.lang.String`	`getProgram()` Returns the Program setting.
`java.lang.String`	`getPublishIds()` Returns publish ID's configure on column
`java.lang.String`	`getRangeFunction()` Returns the Range Function setting.
`java.lang.String`	`getRangeHandlerClass()` Returns the name of the RangeHandler class.
`java.lang.String`	`getRangeProgram()` Returns the Range Program setting.
`java.lang.String`	`getRegisteredSuite()` Returns the Registered Suite setting.
`int`	`getRightTextLength()` Returns the length of right text which will be visible when truncate direction of column is center
`java.lang.String`	`getRotatedHeaderFont()`
`int`	`getRows()` Returns the Rows setting.
`java.lang.String`	`getSetting(java.lang.String name)` Returns the setting with the specified name.
`boolean`	`getSetting(java.lang.String name, boolean defaultValue)` Returns the setting with the specified name.
`int`	`getSetting(java.lang.String name, int defaultValue)` Returns the setting with the specified name.
`java.lang.String`	`getSetting(java.lang.String name, java.lang.String defaultValue)` Returns the setting with the specified name.
`java.util.Iterator<java.lang.String>`	`getSettingNames()` Returns the names of all settings that have been defined.
`boolean`	`getShowAlternateIcon()` Returns the Show Alternate Icon setting.
`boolean`	`getShowObjectImage()` Returns the Show Object Image setting.
`boolean`	`getShowTypeIcon()` Returns the Show Type Icon setting.
`boolean`	`getSortable()` Returns the Sortable setting.
`java.lang.String`	`getSortComparator()` Returns the Sort Comparator setting.
`java.lang.String`	`getSortDirection()` Returns the Sort Direction setting.
`int`	`getSortOrder()` Returns the Sort Order setting.
`java.lang.String`	`getSortType()` Returns the Sort Type setting.
`java.lang.String`	`getStyleCalculation()`
`java.lang.String`	`getStyleCell()`
`java.lang.String`	`getStyleCellValue()`
`java.lang.String`	`getStyleHeader()`
`java.lang.String`	`getTargetLocation()` Returns the Target Location setting.
`java.lang.String`	`getTextAlign()`
`int`	`getTextLength()` Returns the Text Length setting.
`boolean`	`getTranslate()` Returns the Translate setting.
`java.lang.String`	`getTruncateDirection()` Returns the truncate direction of column
`java.lang.String`	`getUpdateFunction()` Returns the Update Function setting.
`java.lang.String`	`getUpdateProgram()` Returns the Update Program setting.
`boolean`	`getUseRule()` Returns the Use Rule setting.
`boolean`	`getUseTransactionOnEdit()`
`boolean`	`getVisibleInEditMode()` Returns the Visible In Edit Mode setting.
`boolean`	`getVisibleInFlatMode()` Returns the Visible In Flat Mode setting.
`boolean`	`getVisibleInReadMode()` Returns the Visible In Read Mode setting.
`boolean`	`getVisibleInStructureMode()` Returns the Visible In Structure Mode setting.
`boolean`	`getVisibleInStructureModificationMode()` Returns the "Visible in Structure Modification Mode" setting
`int`	`getWindowHeight()` Returns the Window Height setting.
`int`	`getWindowWidth()` Returns the Window Width setting.
`boolean`	`hasSetting(java.lang.String name)` Checks if a certain setting has been defined.
`boolean`	`isAlwaysVisible()` Returns the Always Visible setting.
`boolean`	`isAutoComplete()` Returns true if autocomplete is enabled.
`boolean`	`isCalculateAverage()` Returns the Calculate Average setting.
`boolean`	`isCalculateMaximum()` Returns the Calculate Maximum setting.
`boolean`	`isCalculateMedian()` Returns the Calculate Median setting.
`boolean`	`isCalculateMinimum()` Returns the Calculate Minimum setting.
`boolean`	`isCalculateStandardDeviation()` Returns the Calculate Standard Deviation setting.
`boolean`	`isCalculateSum()` Returns the Calculate Sum setting.
`boolean`	`isClassificationAttribute()` Returns true if column is defined to check the interface for attribute data type.
`boolean`	`isColumnType(java.lang.String columnType)` Returns true if the column type is equal to the argument.
`boolean`	`isColumnTypeCheckbox()` Returns true if the column type is checkbox.
`boolean`	`isColumnTypeFile()` Returns true if the column type is file.
`boolean`	`isColumnTypeIcon()` Returns true if the column type is icon.
`boolean`	`isColumnTypeImage()` Returns true if the column type is image.
`boolean`	`isColumnTypeJSFunction()` Returns true if the column type is JSFunction.
`boolean`	`isColumnTypeProgram()` Returns true if the column type is program.
`boolean`	`isColumnTypeProgramHTMLOutput()` Returns true if the column type is programHTMLOutput.
`boolean`	`isColumnTypeSeparator()` Returns true if the column type is separator.
`boolean`	`isColumnTypeUndefined()` Returns true if the column type hasn't been defined, i.e., default.
`boolean`	`isDefaultSearchColumn()` Returns true if DefaultSearchColumn is enabled.
`boolean`	`isDisplayFormat(java.lang.String displayFormat)` Returns true if the Display Format setting is equals to the argument.
`boolean`	`isDisplayFormatIcon()` Returns true if the Display Format setting is Icon.
`boolean`	`isDisplayFormatIconWithLink()` Returns true if the Display Format setting is Icon With Link.
`boolean`	`isDisplayFormatLink()` Returns true if the Display Format setting is Link.
`boolean`	`isDraggableColumn()` Returns true if the column is Draggable
`boolean`	`isEditable()` Returns the Editable setting.
`boolean`	`isExcludeFromReport()` Returns the Exclude From Report setting.
`boolean`	`isFinderEnabled()` Returns true if finder is enabled.
`boolean`	`isFixed()` Returns the Fixed setting.
`boolean`	`isFormat(java.lang.String format)` Returns true if the format is equal to the specified string.
`boolean`	`isFormatBoolean()` Returns true if the format is boolean.
`boolean`	`isFormatDate()` Returns true if the format is date.
`boolean`	`isFormatEmail()` Returns true if the format is email.
`boolean`	`isFormatForEdit()` Returns true if the column value should be formatted on edit.
`boolean`	`isFormatInteger()` Returns true if the format is integer.
`boolean`	`isFormatReal()` Returns true if the format is real.
`boolean`	`isFormatString()` Returns true if the format is string.
`boolean`	`isFormatUndefined()` Returns true if the format setting hasn't been defined.
`boolean`	`isFormatUser()` Returns true if the format is user.
`boolean`	`isGroupable()`
`boolean`	`isGroupHeaderHTML()`
`boolean`	`isHeaderNoWrap()` Returns the Header No Wrap setting.
`boolean`	`isHeaderNoWrapOnExport()`
`boolean`	`isHeaderNoWrapOnPrint()` Returns the Header No Wrap On Print setting.
`boolean`	`isHidden()` Returns the Hidden setting.
`boolean`	`isInCellEdit()`
`boolean`	`isLinkTypeIcon()` Returns the Link Type Icon setting.
`boolean`	`isLocalAttribute()`
`boolean`	`isLocked()` Returns the Locked setting (controls if a column is locked in the table)
`boolean`	`isMatchRangeOnObjectId()`
`boolean`	`isMatchRangeOnRelId()`
`boolean`	`isNavigationColumnEnabled()` Returns true if the column can be used as a navigation column
`boolean`	`isNoWrapOnExport()`
`boolean`	`isPrintable()` Returns the Printable setting.
`boolean`	`isRenderAsRowAction()`
`boolean`	`isRequired()` Returns the Required setting.
`boolean`	`isResizable()`
`boolean`	`isSearchable()` Returns the Searchable setting.
`boolean`	`isSortRangeValues()` Returns true if the range values retrieved from an attribute or a range program (JPO) should be sorted alphabetically.
`boolean`	`isUserDefColumn()` Returns true if the column is user defined
`boolean`	`isVisible()` Returns the Visible setting.
`java.util.Map<java.lang.String,java.lang.Object>`	`toMap()` The settings as a map.
`boolean`	`usePhysicalId()` Returns true if the column set to use physical id

- Method Detail
  - toMap
```
java.util.Map<java.lang.String,java.lang.Object> toMap()
```
    The settings as a map.
    
    Returns:
    
    The settings as a map.
  - getAccessExpression
```
java.lang.String getAccessExpression()
```
    Returns the Access Expression setting.
    
    Returns:
    
    Returns the Access Expression setting.
  - getAccessFunction
```
java.lang.String getAccessFunction()
```
    Returns the Access Function setting.
    
    Returns:
    
    Returns the Access Function setting.
    
    See Also:
    
    getAccessProgram()
  - getAccessMask
```
java.lang.String getAccessMask()
```
    Returns the Access Mask setting.
    
    Returns:
    
    Returns the Access Mask setting.
  - getAccessProgram
```
java.lang.String getAccessProgram()
```
    Returns the Access Program setting.
    
    Returns:
    
    Returns the Access Program setting.
    
    See Also:
    
    getAccessFunction()
  - getAdminType
```
java.lang.String getAdminType()
```
    Returns the Admin Type setting.
    
    Returns:
    
    Returns the Admin Type setting.
  - getAllowMultipleEdit
```
boolean getAllowMultipleEdit()
```
    Returns the Allow Multiple Edit setting.
    
    Returns:
    
    Returns the Allow Multiple Edit setting.
  - getAllowShowMore
```
boolean getAllowShowMore()
```
    Returns the Allow Show More setting.
    
    Returns:
    
    Returns the Allow Show More setting.
    
    See Also:
    
    getTextLength()
  - getAlternateOIDExpression
```
java.lang.String getAlternateOIDExpression()
```
    Returns the Alternate OID Expression setting.
    
    Returns:
    
    Returns the Alternate OID Expression setting.
    
    See Also:
    
    getAlternateTypeExpression()
  - getAlternateOIDExpressionUsesBusinessObject
```
boolean getAlternateOIDExpressionUsesBusinessObject()
```
    Returns the Alternate OID Expression Uses Business Object setting.
    
    Returns:
    
    Returns the Alternate OID Expression Uses Business Object setting.
    
    See Also:
    
    getAlternateOIDExpression()
  - getAlternateTypeExpression
```
java.lang.String getAlternateTypeExpression()
```
    Returns the Alternate Type Expression setting.
    
    Returns:
    
    Returns the Alternate Type Expression setting.
    
    See Also:
    
    getAlternateOIDExpression()
  - getCardID
```
java.lang.String getCardID()
```
    Returns the Card ID setting.
    
    Returns:
    
    Returns the Card ID setting.
    
    Since:
    
    6.0.0
  - getCardLoadScript
```
java.lang.String getCardLoadScript()
```
    Returns the Card Load Script setting.
    
    Returns:
    
    Returns the Card Load Script setting.
    
    Since:
    
    6.0.0
  - getCardReloadable
```
boolean getCardReloadable()
```
    Returns the Card Reloadable setting.
    
    Returns:
    
    Returns the Card Reloadable setting.
    
    Since:
    
    6.0.0
  - getCardTitle
```
java.lang.String getCardTitle()
```
    Returns the Card Title setting.
    
    Returns:
    
    Returns the Card Title setting.
    
    Since:
    
    6.0.0
  - getCardWidth
```
int getCardWidth()
```
    Returns the Card Width setting.
    
    Returns:
    
    Returns the Card Width setting.
    
    Since:
    
    6.0.0
  - getCellEditableExpression
```
java.lang.String getCellEditableExpression()
```
    Returns the Cell Editable Expression setting.
    
    Returns:
    
    Returns the Cell Editable Expression setting.
    
    Since:
    
    6.0.0
  - getCellShowableExpression
```
java.lang.String getCellShowableExpression()
```
    Returns the Cell Showable Expression setting.
    
    Returns:
    
    Returns the Cell Showable Expression setting.
    
    Since:
    
    6.0.0
  - getCellRendererClass
```
java.lang.String getCellRendererClass()
```
    Returns the Cell Renderer Class setting.
    
    Returns:
    
    Returns the Cell Renderer Class setting.
    
    Since:
    
    6.0.0
  - getCheckFromAccess
```
boolean getCheckFromAccess()
```
    Returns the Check From Access setting.
    
    Returns:
    
    Returns the Check From Access setting.
  - getCheckToAccess
```
boolean getCheckToAccess()
```
    Returns the Check To Access setting.
    
    Returns:
    
    Returns the Check To Access setting.
  - getColumnIcon
```
java.lang.String getColumnIcon()
```
    Returns the Column Icon setting.
    
    Returns:
    
    Returns the Column Icon setting.
  - getColumns
```
int getColumns()
```
    Returns the Columns setting.
    
    Returns:
    
    Returns the Columns setting.
  - getColumnType
```
java.lang.String getColumnType()
```
    Returns the Column Type setting.
    
    Returns:
    
    Returns the Column Type setting.
  - isColumnType
```
boolean isColumnType(java.lang.String columnType)
```
    Returns true if the column type is equal to the argument.
    
    Parameters:
    
    columnType - A column type.
    
    Returns:
    
    Returns true if the column type is equal to the argument.
    
    Since:
    
    6.1.2
  - isColumnTypeProgram
```
boolean isColumnTypeProgram()
```
    Returns true if the column type is program.
    
    Returns:
    
    Returns true if the column type is program.
    
    Since:
    
    6.1.2
  - isColumnTypeProgramHTMLOutput
```
boolean isColumnTypeProgramHTMLOutput()
```
    Returns true if the column type is programHTMLOutput.
    
    Returns:
    
    Returns true if the column type is programHTMLOutput.
    
    Since:
    
    6.1.2
  - isColumnTypeIcon
```
boolean isColumnTypeIcon()
```
    Returns true if the column type is icon.
    
    Returns:
    
    Returns true if the column type is icon.
    
    Since:
    
    6.1.2
  - isColumnTypeImage
```
boolean isColumnTypeImage()
```
    Returns true if the column type is image.
    
    Returns:
    
    Returns true if the column type is image.
    
    Since:
    
    6.1.2
  - isColumnTypeCheckbox
```
boolean isColumnTypeCheckbox()
```
    Returns true if the column type is checkbox.
    
    Returns:
    
    Returns true if the column type is checkbox.
    
    Since:
    
    6.1.2
  - isColumnTypeSeparator
```
boolean isColumnTypeSeparator()
```
    Returns true if the column type is separator.
    
    Returns:
    
    Returns true if the column type is separator.
    
    Since:
    
    6.1.2
  - isColumnTypeFile
```
boolean isColumnTypeFile()
```
    Returns true if the column type is file.
    
    Returns:
    
    Returns true if the column type is file.
    
    Since:
    
    6.1.2
  - isColumnTypeUndefined
```
boolean isColumnTypeUndefined()
```
    Returns true if the column type hasn't been defined, i.e., default.
    
    Returns:
    
    Returns true if the column type is undefined.
    
    Since:
    
    6.1.5
  - getColumnWidth
```
int getColumnWidth()
```
    Returns the Column Width setting.
    
    Returns:
    
    Returns the Column Width setting.
  - getDataHandlerClass
```
java.lang.String getDataHandlerClass()
```
    Returns the name of the DataHandler class.
    
    Returns:
    
    Returns the name of the DataHandler class.
  - getRangeHandlerClass
```
java.lang.String getRangeHandlerClass()
```
    Returns the name of the RangeHandler class.
    
    Returns:
    
    Returns the name of the RangeHandler class.
  - getDecimalFormat
```
java.lang.String getDecimalFormat()
```
    Returns the Decimal format.
    
    Returns:
    
    Returns the Decimal format setting.
  - getDecimalFormatScale
```
int getDecimalFormatScale()
```
    Returns the Decimal format multiplier.
    
    Returns:
    
    Returns the Decimal format multiplier setting.
  - getDescription
```
java.lang.String getDescription()
```
    Returns the Description setting.
    
    Returns:
    
    Returns the Description setting.
  - getEditableExpression
```
java.lang.String getEditableExpression()
```
    Returns the Editable Expression setting.
    
    Returns:
    
    Returns the Editable Expression setting.
  - getEditableFunction
```
java.lang.String getEditableFunction()
```
    Returns the Editable Function setting.
    
    Returns:
    
    Returns the Editable Function setting.
  - getEditableMask
```
java.lang.String getEditableMask()
```
    Returns the Editable Mask setting.
    
    Returns:
    
    Returns the Editable Mask setting.
  - getEditableProgram
```
java.lang.String getEditableProgram()
```
    Returns the Editable Program setting.
    
    Returns:
    
    Returns the Editable Program setting.
  - getFilter
```
boolean getFilter()
```
    Returns the Filter setting.
    
    Returns:
    
    Returns the Filter setting.
  - getFormat
```
java.lang.String getFormat()
```
    Returns the Format setting.
    
    Returns:
    
    Returns the Format setting.
  - isFormat
```
boolean isFormat(java.lang.String format)
```
    Returns true if the format is equal to the specified string.
    
    Parameters:
    
    format - The string that you want to compare with the format setting.
    
    Returns:
    
    True if the format is equal to the specified string.
    
    Since:
    
    6.2.1
  - isFormatDate
```
boolean isFormatDate()
```
    Returns true if the format is date.
    
    Returns:
    
    Returns true if the format is date.
    
    Since:
    
    6.2.1
  - isFormatInteger
```
boolean isFormatInteger()
```
    Returns true if the format is integer.
    
    Returns:
    
    Returns true if the format is integer.
    
    Since:
    
    6.2.1
  - isFormatReal
```
boolean isFormatReal()
```
    Returns true if the format is real.
    
    Returns:
    
    Returns true if the format is real.
    
    Since:
    
    6.2.1
  - isFormatString
```
boolean isFormatString()
```
    Returns true if the format is string.
    
    Returns:
    
    Returns true if the format is string.
    
    Since:
    
    6.2.1
  - isFormatBoolean
```
boolean isFormatBoolean()
```
    Returns true if the format is boolean.
    
    Returns:
    
    Returns true if the format is boolean.
    
    Since:
    
    6.2.1
  - isFormatUser
```
boolean isFormatUser()
```
    Returns true if the format is user.
    
    Returns:
    
    Returns true if the format is user.
    
    Since:
    
    6.2.1
  - isFormatEmail
```
boolean isFormatEmail()
```
    Returns true if the format is email.
    
    Returns:
    
    Returns true if the format is email.
    
    Since:
    
    6.2.1
  - isFormatUndefined
```
boolean isFormatUndefined()
```
    Returns true if the format setting hasn't been defined.
    
    Returns:
    
    Returns true if the setting hasn't been defined.
    
    Since:
    
    6.2.1
  - getFunction
```
java.lang.String getFunction()
```
    Returns the Function setting.
    
    Returns:
    
    Returns the Function setting.
  - getGroupHeader
```
java.lang.String getGroupHeader()
```
    Returns the Group Header setting.
    
    Returns:
    
    Returns the Group Header setting.
  - getHeaderRotationAngle
```
int getHeaderRotationAngle()
```
    Returns:
    
    The rotation angle in degrees for the header. Zero value means no rotation.
    
    Since:
    
    2010.3.0
  - getIconClass
```
java.lang.String getIconClass()
```
    Returns:
    
    The CSS classes for the font icon.
    
    Since:
    
    2016.1.0
  - getInputType
```
java.lang.String getInputType()
```
    Returns the Input Type setting.
    
    Returns:
    
    Returns the Input Type setting.
  - getImageSize
```
java.lang.String getImageSize()
```
    Returns the Image Size setting.
    
    Returns:
    
    Returns the Image Size setting.
  - getNoWrap
```
boolean getNoWrap()
```
    Returns the No Wrap setting.
    
    Returns:
    
    Returns the No Wrap setting.
  - getNoWrapOnPrint
```
boolean getNoWrapOnPrint()
```
    Returns the No Wrap On Print setting.
    
    Returns:
    
    Returns the No Wrap On Print setting.
  - isNoWrapOnExport
```
boolean isNoWrapOnExport()
```
    Returns:
    
    the value of theNo Wrap On Export setting
    
    Since:
    
    2010.3.0
  - isHeaderNoWrapOnExport
```
boolean isHeaderNoWrapOnExport()
```
    Returns:
    
    the value of the Header No Wrap On Export setting
    
    Since:
    
    2010.3.0
  - getPopupModal
```
boolean getPopupModal()
```
    Returns the Popup Modal setting.
    
    Returns:
    
    Returns the Popup Modal setting.
  - getPreserveOutput
```
boolean getPreserveOutput()
```
    Returns the Preserve Output setting.
    
    Returns:
    
    Returns the Preserve Output setting.
  - getProgram
```
java.lang.String getProgram()
```
    Returns the Program setting.
    
    Returns:
    
    Returns the Program setting.
  - getRangeFunction
```
java.lang.String getRangeFunction()
```
    Returns the Range Function setting.
    
    Returns:
    
    Returns the Range Function setting.
  - getRangeProgram
```
java.lang.String getRangeProgram()
```
    Returns the Range Program setting.
    
    Returns:
    
    Returns the Range Program setting.
  - getRegisteredSuite
```
java.lang.String getRegisteredSuite()
```
    Returns the Registered Suite setting.
    
    Returns:
    
    Returns the Registered Suite setting.
  - getRows
```
int getRows()
```
    Returns the Rows setting.
    
    Returns:
    
    Returns the Rows setting.
  - getShowAlternateIcon
```
boolean getShowAlternateIcon()
```
    Returns the Show Alternate Icon setting.
    
    Returns:
    
    Returns the Show Alternate Icon setting.
  - getShowObjectImage
```
boolean getShowObjectImage()
```
    Returns the Show Object Image setting.
    
    Returns:
    
    Returns the Show Object Image setting.
  - getShowTypeIcon
```
boolean getShowTypeIcon()
```
    Returns the Show Type Icon setting.
    
    Returns:
    
    Returns the Show Type Icon setting.
  - getSortable
```
boolean getSortable()
```
    Returns the Sortable setting.
    
    Returns:
    
    Returns the Sortable setting.
  - getSortComparator
```
java.lang.String getSortComparator()
```
    Returns the Sort Comparator setting.
    
    Returns:
    
    Returns the Sort Comparator setting.
  - getSortDirection
```
java.lang.String getSortDirection()
```
    Returns the Sort Direction setting.
    
    Returns:
    
    Returns the Sort Direction setting.
  - getSortOrder
```
int getSortOrder()
```
    Returns the Sort Order setting.
    
    Returns:
    
    Returns the Sort Order setting.
  - getSortType
```
java.lang.String getSortType()
```
    Returns the Sort Type setting.
    
    Returns:
    
    Returns the Sort Type setting.
  - getStyleCalculation
```
java.lang.String getStyleCalculation()
```
    Returns:
    
    Returns the calculations style setting
    
    Since:
    
    2013.1.0
  - getStyleCell
```
java.lang.String getStyleCell()
```
    Returns:
    
    Returns the cell style setting
    
    Since:
    
    2013.1.0
  - getStyleCellValue
```
java.lang.String getStyleCellValue()
```
    Returns:
    
    Returns the cell value style setting
    
    Since:
    
    2013.1.0
  - getStyleHeader
```
java.lang.String getStyleHeader()
```
    Returns:
    
    Returns the header style setting
    
    Since:
    
    2013.1.0
  - getTargetLocation
```
java.lang.String getTargetLocation()
```
    Returns the Target Location setting.
    
    Returns:
    
    Returns the Target Location setting.
  - getTranslate
```
boolean getTranslate()
```
    Returns the Translate setting.
    
    Returns:
    
    Returns the Translate setting.
  - getUpdateFunction
```
java.lang.String getUpdateFunction()
```
    Returns the Update Function setting.
    
    Returns:
    
    Returns the Update Function setting.
  - getUpdateProgram
```
java.lang.String getUpdateProgram()
```
    Returns the Update Program setting.
    
    Returns:
    
    Returns the Update Program setting.
  - getUseRule
```
boolean getUseRule()
```
    Returns the Use Rule setting.
    
    Returns:
    
    Returns the Use Rule setting.
  - getWindowHeight
```
int getWindowHeight()
```
    Returns the Window Height setting.
    
    Returns:
    
    Returns the Window Height setting.
  - getWindowWidth
```
int getWindowWidth()
```
    Returns the Window Width setting.
    
    Returns:
    
    Returns the Window Width setting.
  - getVisibleInEditMode
```
boolean getVisibleInEditMode()
```
    Returns the Visible In Edit Mode setting.
    
    Returns:
    
    Returns the Visible In Edit Mode setting.
  - getVisibleInFlatMode
```
boolean getVisibleInFlatMode()
```
    Returns the Visible In Flat Mode setting.
    
    Returns:
    
    Returns the Visible In Flat Mode setting.
  - getVisibleInReadMode
```
boolean getVisibleInReadMode()
```
    Returns the Visible In Read Mode setting.
    
    Returns:
    
    Returns the Visible In Read Mode setting.
  - getVisibleInStructureMode
```
boolean getVisibleInStructureMode()
```
    Returns the Visible In Structure Mode setting.
    
    Returns:
    
    Returns the Visible In Structure Mode setting.
  - getVisibleInStructureModificationMode
```
boolean getVisibleInStructureModificationMode()
```
    Returns the "Visible in Structure Modification Mode" setting
    
    Returns:
    
    Returns the value of the "Visible in Structure Modification Mode" setting
    
    Since:
    
    2010.3.0
  - isEditable
```
boolean isEditable()
```
    Returns the Editable setting.
    
    Returns:
    
    Returns the Editable setting.
  - isFixed
```
boolean isFixed()
```
    Returns the Fixed setting.
    
    Returns:
    
    Returns the Fixed setting.
  - isGroupable
```
boolean isGroupable()
```
    Returns:
    
    True if the column is groupable
    
    Since:
    
    2012.1.0
  - isGroupHeaderHTML
```
boolean isGroupHeaderHTML()
```
    Returns:
    
    The "Group Header is HTML" setting.
    
    Since:
    
    2011.2.0
  - isHeaderNoWrap
```
boolean isHeaderNoWrap()
```
    Returns the Header No Wrap setting.
    
    Returns:
    
    Returns the Header No Wrap setting.
  - isHeaderNoWrapOnPrint
```
boolean isHeaderNoWrapOnPrint()
```
    Returns the Header No Wrap On Print setting.
    
    Returns:
    
    Returns the Header No Wrap On Print setting.
  - isHidden
```
boolean isHidden()
```
    Returns the Hidden setting.
    
    Returns:
    
    Returns the Hidden setting.
  - isVisible
```
boolean isVisible()
```
    Returns the Visible setting.
    
    Returns:
    
    Returns the Visible setting.
  - getColumnOrientation
```
java.lang.String getColumnOrientation()
```
    Returns the Orientation setting.
    
    Returns:
    
    Returns the Orientation setting.
  - getDisplayFormat
```
java.lang.String getDisplayFormat()
```
    Returns the Display Format setting.
    
    Returns:
    
    Returns the Display Format setting.
    
    Since:
    
    6.2.0
  - isDisplayFormat
```
boolean isDisplayFormat(java.lang.String displayFormat)
```
    Returns true if the Display Format setting is equals to the argument.
    
    Parameters:
    
    displayFormat - The argument.
    
    Returns:
    
    Returns true if equal.
    
    Since:
    
    6.2.0
  - isDisplayFormatIcon
```
boolean isDisplayFormatIcon()
```
    Returns true if the Display Format setting is Icon.
    
    Returns:
    
    Returns true if the Display Format setting is Icon.
    
    Since:
    
    6.2.0
  - isDisplayFormatLink
```
boolean isDisplayFormatLink()
```
    Returns true if the Display Format setting is Link.
    
    Returns:
    
    Returns true if the Display Format setting is Link.
    
    Since:
    
    6.2.0
  - isDisplayFormatIconWithLink
```
boolean isDisplayFormatIconWithLink()
```
    Returns true if the Display Format setting is Icon With Link.
    
    Returns:
    
    Returns true if the Display Format setting is Icon With Link.
    
    Since:
    
    6.2.0
  - getDisplaySeparator
```
java.lang.String getDisplaySeparator()
```
    Returns the Display Separator setting.
    
    Returns:
    
    Returns the Display Separator setting.
  - getTextLength
```
int getTextLength()
```
    Returns the Text Length setting.
    
    Returns:
    
    Returns the Text Length setting.
  - isExcludeFromReport
```
boolean isExcludeFromReport()
```
    Returns the Exclude From Report setting.
    
    Returns:
    
    Returns the Exclude From Report setting.
  - getExcelDataFormat
```
java.lang.String getExcelDataFormat()
```
    Returns:
    
    The format of the value in Excel.
    
    Since:
    
    2012.2.0
  - getAllowedInCharts
```
boolean getAllowedInCharts()
```
    Returns the Allowed In Charts setting.
    
    Returns:
    
    Returns the Allowed In Charts setting.
  - isPrintable
```
boolean isPrintable()
```
    Returns the Printable setting.
    
    Returns:
    
    Returns the Printable setting.
  - isSearchable
```
boolean isSearchable()
```
    Returns the Searchable setting.
    
    Returns:
    
    Returns the Searchable setting.
  - isLinkTypeIcon
```
boolean isLinkTypeIcon()
```
    Returns the Link Type Icon setting.
    
    Returns:
    
    Returns the Link Type Icon setting.
  - isRequired
```
boolean isRequired()
```
    Returns the Required setting.
    
    Returns:
    
    Returns the Required setting.
    
    Since:
    
    6.1.6
  - isLocked
```
boolean isLocked()
```
    Returns the Locked setting (controls if a column is locked in the table)
    
    Returns:
    
    Returns the Locked setting.
    
    Since:
    
    2010.2.0
  - isAlwaysVisible
```
boolean isAlwaysVisible()
```
    Returns the Always Visible setting.
    
    Returns:
    
    Returns the Always Visible setting.
    
    Since:
    
    6.1.6
  - isCalculateSum
```
boolean isCalculateSum()
```
    Returns the Calculate Sum setting.
    
    Returns:
    
    Returns the Calculate Sum setting.
    
    Since:
    
    6.3.3
  - isCalculateAverage
```
boolean isCalculateAverage()
```
    Returns the Calculate Average setting.
    
    Returns:
    
    Returns the Calculate Average setting.
    
    Since:
    
    6.3.3
  - isCalculateMaximum
```
boolean isCalculateMaximum()
```
    Returns the Calculate Maximum setting.
    
    Returns:
    
    Returns the Calculate Maximum setting.
    
    Since:
    
    6.3.3
  - isCalculateMinimum
```
boolean isCalculateMinimum()
```
    Returns the Calculate Minimum setting.
    
    Returns:
    
    Returns the Calculate Minimum setting.
    
    Since:
    
    6.3.3
  - isCalculateMedian
```
boolean isCalculateMedian()
```
    Returns the Calculate Median setting.
    
    Returns:
    
    Returns the Calculate Median setting.
    
    Since:
    
    6.3.3
  - isCalculateStandardDeviation
```
boolean isCalculateStandardDeviation()
```
    Returns the Calculate Standard Deviation setting.
    
    Returns:
    
    Returns the Calculate Standard Deviation setting.
    
    Since:
    
    6.3.3
  - getGroupCalculation
```
java.lang.String getGroupCalculation()
```
    Returns the calculation(s) to be shown in group cell setting.
    
    Returns:
    
    Comma separated string values of group calculation functions.
    
    Since:
    
    2014.2.0
  - getCalculationDecimalPrecision
```
int getCalculationDecimalPrecision()
```
    Returns the Calculation Decimal Precision setting.
    
    Returns:
    
    Returns the Calculation Decimal Precision setting.
    
    Since:
    
    6.3.3
  - isSortRangeValues
```
boolean isSortRangeValues()
```
    Returns true if the range values retrieved from an attribute or a range program (JPO) should be sorted alphabetically. If you write a custom RangeHandler it is up to you to decide whether to want it to support this setting or not.
    
    Returns:
    
    True if the range values should be sorted.
    
    Since:
    
    6.4.1
  - getTextAlign
```
java.lang.String getTextAlign()
```
    Returns:
    
    The alignment.
    
    Since:
    
    6.4.2
  - isResizable
```
boolean isResizable()
```
    Returns:
    
    The value of the resizable setting
    
    Since:
    
    2011.3.0
  - getRotatedHeaderFont
```
java.lang.String getRotatedHeaderFont()
```
    Returns:
    
    The font specification for the rotated header.
    
    Since:
    
    2011.1.0
  - isMatchRangeOnObjectId
```
boolean isMatchRangeOnObjectId()
```
    Returns:
    
    True if to match range values based on object id instead of the cell-value
    
    Since:
    
    2012.1.0
  - isMatchRangeOnRelId
```
boolean isMatchRangeOnRelId()
```
    Returns:
    
    True if to match range values based on relationship id instead of the cell-value
    
    Since:
    
    2012.1.0
  - isRenderAsRowAction
```
boolean isRenderAsRowAction()
```
    Returns:
    
    True if the column is rendered within the row-action menu
    
    Since:
    
    2012.1.0
  - getSetting
```
java.lang.String getSetting(java.lang.String name)
```
    Returns the setting with the specified name.
    
    Parameters:
    
    name - The name of a setting.
    
    Returns:
    
    Returns the value of the setting with the specified name.
  - getSetting
```
java.lang.String getSetting(java.lang.String name,
                            java.lang.String defaultValue)
```
    Returns the setting with the specified name.
    
    Parameters:
    
    name - The name of a setting.
    
    defaultValue - The default value that will be returned if the named setting doesn't have a value.
    
    Returns:
    
    Returns the value of the setting, or the default value if the setting doesn't have a value.
  - getSetting
```
int getSetting(java.lang.String name,
               int defaultValue)
```
    Returns the setting with the specified name.
    
    Parameters:
    
    name - The name of a setting.
    
    defaultValue - The default value that will be returned if the named setting doesn't have a value or it the value that it has can't be parsed.
    
    Returns:
    
    Returns the value of the setting, or the default value if the setting doesn't have a value or it it couldn't be parsed.
  - getSetting
```
boolean getSetting(java.lang.String name,
                   boolean defaultValue)
```
    Returns the setting with the specified name.
    
    Parameters:
    
    name - The name of a setting.
    
    defaultValue - The default value that will be returned if the named setting doesn't have a value.
    
    Returns:
    
    Returns the value of the setting or the default value if the setting doesn't have a value.
  - getSettingNames
```
java.util.Iterator<java.lang.String> getSettingNames()
```
    Returns the names of all settings that have been defined.
    
    Returns:
    
    Returns the names of all settings that have been defined.
  - hasSetting
```
boolean hasSetting(java.lang.String name)
```
    Checks if a certain setting has been defined.
    
    Parameters:
    
    name - The name of the setting.
    
    Returns:
    
    True if the setting has been defined.
    
    Since:
    
    2009.1
  - isNavigationColumnEnabled
```
boolean isNavigationColumnEnabled()
```
    Returns true if the column can be used as a navigation column
    
    Returns:
    
    True if navigation column is enabled for the column
    
    Since:
    
    2013.1.0
  - isLocalAttribute
```
boolean isLocalAttribute()
```
    Returns:
    
    True if this column might select data from a local attribute.
    
    Since:
    
    2013.1.0
  - isInCellEdit
```
boolean isInCellEdit()
```
    Returns:
    
    True if in cell edit is enabled for the column
    
    Since:
    
    2013.2.0
  - isFinderEnabled
```
boolean isFinderEnabled()
```
    Returns true if finder is enabled.
    
    Returns:
    
    True if finder is enabled
    
    Since:
    
    2013.3.0
  - getFinderFieldClass
```
java.lang.String getFinderFieldClass()
```
    Returns the custom finder class. The class name is qualified.
    
    Returns:
    
    Qualified class name of custom finder field
    
    Since:
    
    2013.3.0
  - getFinderRendererClass
```
java.lang.String getFinderRendererClass()
```
    Returns the finder renderer class. The class name is qualified.
    
    Returns:
    
    Qualified class name of renderer for finder field
    
    Since:
    
    2013.3.0
  - getFinderType
```
java.lang.String getFinderType()
```
    Returns the type of finder field, e.g. freetext, range or boolean.
    
    Returns:
    
    Type of finder field
    
    Since:
    
    2013.3.0
  - getFinderOperator
```
java.lang.String getFinderOperator()
```
    Returns the operator of finder field.
    
    Returns:
    
    Query operator for the finder field
    
    Since:
    
    2013.3.0
  - getFinderLabel
```
java.lang.String getFinderLabel()
```
    Returns the label of the finder field.
    
    Returns:
    
    The label of the finder field
    
    Since:
    
    2013.3.0
  - getFinderTooltip
```
java.lang.String getFinderTooltip()
```
    Return the tooltip of the finder field.
    
    Returns:
    
    Tooltip of the finder field
    
    Since:
    
    2013.3.0
  - getFinderOrder
```
int getFinderOrder()
```
    Return the order in which to render the finder field.
    
    Returns:
    
    Order to render the finder field in
    
    Since:
    
    2013.3.0
  - isAutoComplete
```
boolean isAutoComplete()
```
    Returns true if autocomplete is enabled.
    
    Returns:
    
    True if enabled.
    
    Since:
    
    2014.2.0
  - getAutoCompleteHandler
```
java.lang.String getAutoCompleteHandler()
```
    The AutoCompleteHandler to use.
    
    Returns:
    
    The name of the handler
    
    Since:
    
    2014.2.0
  - getAutoCompleteSettings
```
java.lang.String getAutoCompleteSettings()
```
    Settings for the autocomplete. These settings have higher priority than the default ones that are used for tables. Any (configurable) behavior can be overridden.
    
    Returns:
    
    The settings in JSON format
    
    Since:
    
    2014.2.0
  - getUseTransactionOnEdit
```
boolean getUseTransactionOnEdit()
```
    Returns:
    
    True if to perform the cell edit within an update transaction.
    
    Since:
    
    2014.3.0
  - isDefaultSearchColumn
```
boolean isDefaultSearchColumn()
```
    Returns true if DefaultSearchColumn is enabled.
    
    Returns:
    
    True if enabled.
    
    Since:
    
    2015.3.0
  - isColumnTypeJSFunction
```
boolean isColumnTypeJSFunction()
```
    Returns true if the column type is JSFunction.
    
    Returns:
    
    Returns true if the column type is JSFunction.
    
    Since:
    
    6.1.2
  - isFormatForEdit
```
boolean isFormatForEdit()
```
    Returns true if the column value should be formatted on edit.
    
    Returns:
    
    Returns true if the column value should be formatted on edit.
    
    Since:
    
    2018.2.0
  - getPublishIds
```
java.lang.String getPublishIds()
```
    Returns publish ID's configure on column
    
    Returns:
    
    Returns publish ID's configure on column
    
    Since:
    
    2019.3.0
  - isUserDefColumn
```
boolean isUserDefColumn()
```
    Returns true if the column is user defined
    
    Returns:
    
    Returns true if column is user defined
    
    Since:
    
    2020.3.0
  - getAlternatePolicyExpression
```
java.lang.String getAlternatePolicyExpression()
```
    Returns the Alternate Policy Expression setting.
    
    Returns:
    
    Returns the Alternate Policy Expression setting.
    
    Since:
    
    2020.4.0
    
    See Also:
    
    getAlternatePolicyExpression()
  - isDraggableColumn
```
boolean isDraggableColumn()
```
    Returns true if the column is Draggable
    
    Returns:
    
    Returns true if the column configure for drag event
    
    Since:
    
    2020.5.0
  - usePhysicalId
```
boolean usePhysicalId()
```
    Returns true if the column set to use physical id
    
    Returns:
    
    Returns true/false
    
    Since:
    
    2021.2.0
  - getTruncateDirection
```
java.lang.String getTruncateDirection()
```
    Returns the truncate direction of column
    
    Returns:
    
    Returns truncate direction of column
    
    Since:
    
    2020.5.0
  - getLeftTextLength
```
int getLeftTextLength()
```
    Returns the length of left text which will be visible when truncate direction of column is center
    
    Returns:
    
    Returns length of left text
    
    Since:
    
    2020.5.0
  - getRightTextLength
```
int getRightTextLength()
```
    Returns the length of right text which will be visible when truncate direction of column is center
    
    Returns:
    
    Returns length of right text
    
    Since:
    
    2020.5.0
  - isClassificationAttribute
```
boolean isClassificationAttribute()
```
    Returns true if column is defined to check the interface for attribute data type.
    
    Since:
    
    2023.2.0

Interface ColumnSettings

Method Summary

Method Detail

toMap

getAccessExpression

getAccessFunction

getAccessMask

getAccessProgram

getAdminType

getAllowMultipleEdit

getAllowShowMore

getAlternateOIDExpression

getAlternateOIDExpressionUsesBusinessObject

getAlternateTypeExpression

getCardID

getCardLoadScript

getCardReloadable

getCardTitle

getCardWidth

getCellEditableExpression

getCellShowableExpression

getCellRendererClass

getCheckFromAccess

getCheckToAccess

getColumnIcon

getColumns

getColumnType

isColumnType

isColumnTypeProgram

isColumnTypeProgramHTMLOutput

isColumnTypeIcon

isColumnTypeImage

isColumnTypeCheckbox

isColumnTypeSeparator

isColumnTypeFile

isColumnTypeUndefined

getColumnWidth

getDataHandlerClass

getRangeHandlerClass

getDecimalFormat

getDecimalFormatScale

getDescription

getEditableExpression

getEditableFunction

getEditableMask

getEditableProgram

getFilter

getFormat

isFormat

isFormatDate

isFormatInteger

isFormatReal

isFormatString

isFormatBoolean

isFormatUser

isFormatEmail

isFormatUndefined

getFunction

getGroupHeader

getHeaderRotationAngle

getIconClass

getInputType

getImageSize

getNoWrap

getNoWrapOnPrint

isNoWrapOnExport

isHeaderNoWrapOnExport

getPopupModal

getPreserveOutput

getProgram

getRangeFunction

getRangeProgram

getRegisteredSuite

getRows

getShowAlternateIcon

getShowObjectImage

getShowTypeIcon

getSortable

getSortComparator

getSortDirection