UIOptions (Maximo API)

java.lang.Object
- com.ibm.tivoli.maximo.miniapps.scheduler.UIOptions

All Implemented Interfaces:

HasProperties
```
public class UIOptions
extends java.lang.Object
implements HasProperties
```
Configuration for the TreeGrid UI options

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`UIOptions.GanttOptions`
`static class`	`UIOptions.PagerMode`
`static class`	`UIOptions.ToolbarOptions`
`static class`	`UIOptions.UIMode`

Field Summary

Fields
Modifier and Type	Field and Description
`java.util.Map`	`actions`
`java.util.List`	`additionalLockedColumns`
`int`	`allowUndo`
`boolean`	`buildInfoRow` If we want to build the info row in the schedule
`boolean`	`canEdit`
`java.lang.String`	`cfgId`
`java.lang.String`	`columnBeforeDescription`
`boolean`	`customGrouping`
`java.lang.String`	`defaultSearchExpression`
`java.lang.String`	`defaultSort`
`boolean`	`export`
`static int`	`FILTER_HIDE_ALL_NOT_FOUND` http://www.treegrid.com/Doc/Filter.htm#CfgStandardFilter Filter behavior in tree 0 (Hide all not found) The filter is applied to parents before children to speed up filtering.
`static int`	`FILTER_HIDE_ALL_NOT_FOUND_ITERATE_ALL`
`static int`	`FILTER_SHOW_ALL_FOUND`
`static int`	`FILTER_SHOW_ALL_FOUND_WITH_CHILDREN`
`boolean`	`filterHideParents`
`int`	`filterMode` http://www.treegrid.com/Doc/Filter.htm#CfgStandardFilter Filter behavior in tree 0 (Hide all not found) The filter is applied to parents before children to speed up filtering.
`boolean`	`filterToggleVisible`
`boolean`	`filterVisible`
`int`	`ganttBottom`
`boolean`	`ganttCanHide`
`UIOptions.GanttOptions`	`ganttOptions`
`java.lang.String`	`gridTitle`
`java.lang.String`	`groupCol`
`boolean`	`infoRowEnbled` If we want to see the info row in the schedule
`java.lang.String`	`infoRowTextTemplate` Localized info row label
`boolean`	`isSelectionEnabled`
`int`	`maxSortColumns`
`int`	`minRowHeight`
`int`	`minTreeIconsInHeader`
`UIOptions.UIMode`	`mode`
`static int`	`NO_SELECT_COLLAPSED_ROWS`
`static int`	`NO_SELECT_DELETED_ROWS` Selection Args When the whole row or column selection is cleared.
`static int`	`NO_SELECT_FILTERED_ROWS`
`static int`	`NO_SELECT_MANUALLY_HIDDEN_ROWS`
`UIOptions.PagerMode`	`pagerMode`
`com.ibm.tivoli.maximo.miniapps.scheduler.UIOptions.Paging`	`paging` Paging settings for the Gantt.
`com.ibm.tivoli.maximo.miniapps.scheduler.UIOptions.Perf`	`perf`
`boolean`	`printExpanded`
`static int`	`RESIZE_BOTH`
`static int`	`RESIZE_HORIZONTAL`
`static int`	`RESIZE_NONE` Resize Flags
`static int`	`RESIZE_SHOW_GRID_WHEN_RESIZING`
`static int`	`RESIZE_VERTICAL`
`int`	`resizeOptions` Default is 0 - no resize, 1 = vert resize, 2 = horz, 3 = botth, +4 will show gantt when resizing
`boolean`	`rowCalendars`
`boolean`	`saveExpanded`
`boolean`	`saveFilters`
`boolean`	`saveScrollLeft`
`boolean`	`saveScrollTop`
`boolean`	`saveSearch`
`boolean`	`saveSelected`
`boolean`	`saveState`
`boolean`	`saveValues`
`boolean`	`searchVisible`
`int`	`selectionMode`
`int`	`stripeRows`
`boolean`	`syncEnabled`
`java.lang.String`	`syncId`
`int`	`tableWidth`
`UIOptions.ToolbarOptions`	`toolbar`
`boolean`	`toolbarVisible`
`int`	`tooltipDelayMS`
`int`	`tooltipShowDurationMS`
`int`	`treeIconsInHeader`
`boolean`	`wrapSearchAtEnd`
`boolean`	`zoomIn`
`boolean`	`zoomOut`
`boolean`	`zoomToFit`
`boolean`	`zoomToWeek`
`boolean`	`zoomToWork`

Constructor Summary

Constructors
Constructor and Description

UIOptions(java.util.Properties skdProps)

Constructors
Constructor and Description
`UIOptions(java.util.Properties skdProps)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addColumn(TreeGridColumn col)`
`boolean`	`canEdit(java.lang.String field)`
`boolean`	`getBooleanProperty(java.lang.String prop, boolean defValue)`
`int`	`getIntProperty(java.lang.String prop, int defValue)` Gets a System Property from the SKD System Properties (remember, don't pass skd.
`java.lang.Object`	`getProperty(java.lang.String prop)` Gets a System Property from the SKD System Properties (remember, don't pass skd.
`java.lang.String`	`getProperty(java.lang.String prop, java.lang.String def)`
`void`	`setCanEdit(java.lang.String field)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - RESIZE_NONE
```
public static final int RESIZE_NONE
```
    Resize Flags
    
    See Also:
    
    Constant Field Values
  - RESIZE_VERTICAL
```
public static final int RESIZE_VERTICAL
```
    See Also:
    
    Constant Field Values
  - RESIZE_HORIZONTAL
```
public static final int RESIZE_HORIZONTAL
```
    See Also:
    
    Constant Field Values
  - RESIZE_BOTH
```
public static final int RESIZE_BOTH
```
    See Also:
    
    Constant Field Values
  - RESIZE_SHOW_GRID_WHEN_RESIZING
```
public static final int RESIZE_SHOW_GRID_WHEN_RESIZING
```
    See Also:
    
    Constant Field Values
  - NO_SELECT_DELETED_ROWS
```
public static final int NO_SELECT_DELETED_ROWS
```
    Selection Args When the whole row or column selection is cleared. For cell selecting use SelectHidden instead. It affects also SearchAction Select. It affects also SelectAll / DeselectAll / InvertAll actions, e.g. to affect only all visible rows, set ClearSelected='6'. 1.bit &1 If selection is cleared for deleted rows / columns. 2.bit &2 If selection is cleared for filtered rows / columns. 3.bit &4 If selection is cleared for manually hidden rows / columns. 4.bit &8 If selection is cleared for collapsed child rows.
    
    See Also:
    
    Constant Field Values
  - NO_SELECT_FILTERED_ROWS
```
public static final int NO_SELECT_FILTERED_ROWS
```
    See Also:
    
    Constant Field Values
  - NO_SELECT_MANUALLY_HIDDEN_ROWS
```
public static final int NO_SELECT_MANUALLY_HIDDEN_ROWS
```
    See Also:
    
    Constant Field Values
  - NO_SELECT_COLLAPSED_ROWS
```
public static final int NO_SELECT_COLLAPSED_ROWS
```
    See Also:
    
    Constant Field Values
  - FILTER_HIDE_ALL_NOT_FOUND
```
public static final int FILTER_HIDE_ALL_NOT_FOUND
```
    http://www.treegrid.com/Doc/Filter.htm#CfgStandardFilter Filter behavior in tree 0 (Hide all not found) The filter is applied to parents before children to speed up filtering. The filter is applied to children only if the parent fulfills the condition. 1 (Hide all not found, iterate all) The filter is applied to children before filtering parent. Use it if parent is filtered according to visibility of its children, when uses aggregate functions. It can be much slower than 0. 2 (Show all found) It shows all rows that fulfill the filter condition in tree. It shows all parent rows if some their children fulfill the condition. The filter is applied to children before filtering parent. 3 (new 9.0) (Show all found, with all children) It shows all rows that fulfill the filter condition in tree, with all their children. The filter is applied to parent before children. The filter is applied to children only if the parent does not fulfill the condition.
    
    See Also:
    
    Constant Field Values
  - FILTER_HIDE_ALL_NOT_FOUND_ITERATE_ALL
```
public static final int FILTER_HIDE_ALL_NOT_FOUND_ITERATE_ALL
```
    See Also:
    
    Constant Field Values
  - FILTER_SHOW_ALL_FOUND
```
public static final int FILTER_SHOW_ALL_FOUND
```
    See Also:
    
    Constant Field Values
  - FILTER_SHOW_ALL_FOUND_WITH_CHILDREN
```
public static final int FILTER_SHOW_ALL_FOUND_WITH_CHILDREN
```
    See Also:
    
    Constant Field Values
  - additionalLockedColumns
```
public java.util.List additionalLockedColumns
```
  - ganttOptions
```
public UIOptions.GanttOptions ganttOptions
```
  - toolbar
```
public UIOptions.ToolbarOptions toolbar
```
  - toolbarVisible
```
public boolean toolbarVisible
```
  - filterVisible
```
public boolean filterVisible
```
  - filterMode
```
public int filterMode
```
    http://www.treegrid.com/Doc/Filter.htm#CfgStandardFilter Filter behavior in tree 0 (Hide all not found) The filter is applied to parents before children to speed up filtering. The filter is applied to children only if the parent fulfills the condition. 1 (Hide all not found, iterate all) The filter is applied to children before filtering parent. Use it if parent is filtered according to visibility of its children, when uses aggregate functions. It can be much slower than 0. 2 (Show all found) It shows all rows that fulfill the filter condition in tree. It shows all parent rows if some their children fulfill the condition. The filter is applied to children before filtering parent. 3 (new 9.0) (Show all found, with all children) It shows all rows that fulfill the filter condition in tree, with all their children. The filter is applied to parent before children. The filter is applied to children only if the parent does not fulfill the condition.
  - filterHideParents
```
public boolean filterHideParents
```
  - selectionMode
```
public int selectionMode
```
  - pagerMode
```
public UIOptions.PagerMode pagerMode
```
  - searchVisible
```
public boolean searchVisible
```
  - filterToggleVisible
```
public boolean filterToggleVisible
```
  - mode
```
public UIOptions.UIMode mode
```
  - allowUndo
```
public int allowUndo
```
  - stripeRows
```
public int stripeRows
```
  - maxSortColumns
```
public int maxSortColumns
```
  - tooltipDelayMS
```
public int tooltipDelayMS
```
  - tooltipShowDurationMS
```
public int tooltipShowDurationMS
```
  - customGrouping
```
public boolean customGrouping
```
  - rowCalendars
```
public boolean rowCalendars
```
  - syncEnabled
```
public boolean syncEnabled
```
  - syncId
```
public java.lang.String syncId
```
  - cfgId
```
public java.lang.String cfgId
```
  - isSelectionEnabled
```
public boolean isSelectionEnabled
```
  - canEdit
```
public boolean canEdit
```
  - defaultSort
```
public java.lang.String defaultSort
```
  - columnBeforeDescription
```
public java.lang.String columnBeforeDescription
```
  - gridTitle
```
public java.lang.String gridTitle
```
  - saveState
```
public boolean saveState
```
  - saveSelected
```
public boolean saveSelected
```
  - saveExpanded
```
public boolean saveExpanded
```
  - saveFilters
```
public boolean saveFilters
```
  - saveValues
```
public boolean saveValues
```
  - saveScrollLeft
```
public boolean saveScrollLeft
```
  - saveScrollTop
```
public boolean saveScrollTop
```
  - saveSearch
```
public boolean saveSearch
```
  - wrapSearchAtEnd
```
public boolean wrapSearchAtEnd
```
  - printExpanded
```
public boolean printExpanded
```
  - zoomToWeek
```
public boolean zoomToWeek
```
  - zoomIn
```
public boolean zoomIn
```
  - zoomOut
```
public boolean zoomOut
```
  - zoomToFit
```
public boolean zoomToFit
```
  - zoomToWork
```
public boolean zoomToWork
```
  - export
```
public boolean export
```
  - ganttCanHide
```
public boolean ganttCanHide
```
  - groupCol
```
public java.lang.String groupCol
```
  - tableWidth
```
public int tableWidth
```
  - minRowHeight
```
public int minRowHeight
```
  - actions
```
public java.util.Map actions
```
  - defaultSearchExpression
```
public java.lang.String defaultSearchExpression
```
  - treeIconsInHeader
```
public int treeIconsInHeader
```
  - minTreeIconsInHeader
```
public int minTreeIconsInHeader
```
  - ganttBottom
```
public int ganttBottom
```
  - resizeOptions
```
public int resizeOptions
```
    Default is 0 - no resize, 1 = vert resize, 2 = horz, 3 = botth, +4 will show gantt when resizing
    
    See Also:
    
    http://www.treegrid.com/Doc/GridSize.htm#CfgResizingMain
  - infoRowEnbled
```
public boolean infoRowEnbled
```
    If we want to see the info row in the schedule
  - infoRowTextTemplate
```
public java.lang.String infoRowTextTemplate
```
    Localized info row label
  - paging
```
public com.ibm.tivoli.maximo.miniapps.scheduler.UIOptions.Paging paging
```
    Paging settings for the Gantt.
  - buildInfoRow
```
public boolean buildInfoRow
```
    If we want to build the info row in the schedule
  - perf
```
public com.ibm.tivoli.maximo.miniapps.scheduler.UIOptions.Perf perf
```
- Constructor Detail
  - UIOptions
```
public UIOptions(java.util.Properties skdProps)
```
- Method Detail
  - canEdit
```
public boolean canEdit(java.lang.String field)
```
  - setCanEdit
```
public void setCanEdit(java.lang.String field)
```
  - getProperty
```
public java.lang.Object getProperty(java.lang.String prop)
```
    Gets a System Property from the SKD System Properties (remember, don't pass skd. in the property name)
    
    Specified by:
    
    getProperty in interface HasProperties
    
    Parameters:
    
    prop -
    
    Returns:
  - getProperty
```
public java.lang.String getProperty(java.lang.String prop,
                                    java.lang.String def)
```
  - getIntProperty
```
public int getIntProperty(java.lang.String prop,
                          int defValue)
```
    Gets a System Property from the SKD System Properties (remember, don't pass skd. in the property name)
    
    Parameters:
    
    prop -
    
    Returns:
    
    the property value as an int
  - getBooleanProperty
```
public boolean getBooleanProperty(java.lang.String prop,
                                  boolean defValue)
```
  - addColumn
```
public void addColumn(TreeGridColumn col)
```

Methods inherited from class java.lang.Object

RESIZE_NONE

RESIZE_VERTICAL

RESIZE_HORIZONTAL

RESIZE_BOTH

RESIZE_SHOW_GRID_WHEN_RESIZING

NO_SELECT_DELETED_ROWS

NO_SELECT_FILTERED_ROWS

NO_SELECT_MANUALLY_HIDDEN_ROWS

NO_SELECT_COLLAPSED_ROWS

FILTER_HIDE_ALL_NOT_FOUND

FILTER_HIDE_ALL_NOT_FOUND_ITERATE_ALL

FILTER_SHOW_ALL_FOUND

FILTER_SHOW_ALL_FOUND_WITH_CHILDREN

additionalLockedColumns

ganttOptions

toolbar

toolbarVisible

filterVisible

filterMode

filterHideParents

selectionMode

pagerMode

searchVisible

filterToggleVisible

mode

allowUndo

stripeRows

maxSortColumns

tooltipDelayMS

tooltipShowDurationMS

customGrouping

rowCalendars

syncEnabled

syncId

cfgId

isSelectionEnabled

canEdit

defaultSort

columnBeforeDescription

gridTitle

saveState

saveSelected

saveExpanded

saveFilters

saveValues

saveScrollLeft

saveScrollTop

saveSearch

wrapSearchAtEnd

printExpanded

zoomToWeek

zoomIn

zoomOut

zoomToFit

zoomToWork

export

ganttCanHide

groupCol

tableWidth

minRowHeight

actions

defaultSearchExpression

treeIconsInHeader

minTreeIconsInHeader

ganttBottom

resizeOptions

infoRowEnbled

infoRowTextTemplate

paging

buildInfoRow

perf

UIOptions

canEdit

setCanEdit

getProperty

getProperty

getIntProperty

getBooleanProperty

addColumn