Package com.ptc.mvc.components

Interface TreeConfig

All Superinterfaces:

BasicTableConfig, ComponentConfig, CustomizableViewConfig, TableConfig

All Known Implementing Classes:

JcaTreeConfig

public interface TreeConfig
extends TableConfig

Describes a tree component
Supported API: true

Extendable: false

Method Summary

Modifier and Type	Method	Description
String	getExpansionLevel()	Get the initial expansion level of the tree Supported API: true
String	getNodeColumn()	Get the name of the column that will be used to display node labels.
boolean	isShowTreeLines()	Whether tree lines will be displayed to show structure in the tree Supported API: true
void	setExpansionLevel(String expansionLevel)	Set the the initial expansion level of the tree. none (fully collapsed, one (first level of tree is expanded) full (tree is fully expanded). Defaults to full.
void	setNodeColumn(String nodeColumn)	Set the name of the column that will be used to display expand/collapse nodes.
void	setShowTreeLines(boolean showTreeLines)	Set whether tree lines will be displayed to show structure in the tree Defaults to false Supported API: true

Methods inherited from interface com.ptc.mvc.components.BasicTableConfig

getSummary, isShowCount, setShowCount, setSummary

Methods inherited from interface com.ptc.mvc.components.ComponentConfig

addComponent, addComponents, getActionModel, getComponentMode, getComponents, getComponentType, getHelpContext, getId, getLabel, getTargetObject, getType, getTypes, removeComponent, setActionModel, setComponentMode, setComponentType, setHelpContext, setId, setLabel, setTargetObject, setType, setTypes

Methods inherited from interface com.ptc.mvc.components.CustomizableViewConfig

getView, setView

Methods inherited from interface com.ptc.mvc.components.TableConfig

getDisableAction, getGroupBy, getMenubarName, getStrikeThroughColumn, isConfigurable, isFreezable, isRowBasedObjectHandle, isSelectable, isShowCustomViewLink, isSingleSelect, isSingleViewOnly, setConfigurable, setDisableAction, setFindInTableMode, setFreezable, setGroupBy, setMenubarName, setNonSelectableColumn, setPreSelectableColumn, setRowBasedObjectHandle, setSelectable, setShowCustomViewLink, setSingleSelect, setSingleViewOnly, setStrikeThroughColumn

Method Details

getExpansionLevel

String getExpansionLevel()

Get the initial expansion level of the tree

Supported API: true

Returns:

String

setExpansionLevel

void setExpansionLevel(String expansionLevel)

Set the the initial expansion level of the tree.
none (fully collapsed,
one (first level of tree is expanded)
full (tree is fully expanded).
Defaults to full.

Supported API: true

Parameters:

expansionLevel -

getNodeColumn

String getNodeColumn()

Get the name of the column that will be used to display node labels.

Supported API: true

Returns:

setNodeColumn

void setNodeColumn(String nodeColumn)

Set the name of the column that will be used to display expand/collapse nodes. Defaults to name column

Supported API: true

Parameters:

nodeColumn -

isShowTreeLines

boolean isShowTreeLines()

Whether tree lines will be displayed to show structure in the tree

Supported API: true

Returns:

setShowTreeLines

void setShowTreeLines(boolean showTreeLines)

Set whether tree lines will be displayed to show structure in the tree Defaults to false

Supported API: true

Parameters:

showTreeLines -