TreePanelColumn¶
Definition¶
Extends¶
Extended By¶
None
Description¶
Represents a column within a TreePanel object. It can be accessed using treePanelObj.getColumn(colName).
Method Summary¶
| Owner | Name | Return Type | Description |
|---|---|---|---|
| TreePanelColumn | autosize() | Boolean | Autosizes this tree column. Returns true if operation is successful, false otherwise. |
| DashboardResource | getCallback(callbackName) | Callback | Returns a callback by name |
| DashboardResource | getCallbacks() | Map | Returns a map of all callback definitions. |
| DashboardResource | getChildren() | List | Returns a list of the child dashboard resources. |
| Object | getClassName() | String | Returns the string name of this object's class type. |
| TreePanelColumn | getCssClass() | String | Returns the css class associated with the column. |
| DashboardResource | getDRI() | String | Returns the Dashboard Resource Indicator (DRI) as a string. DRI is the unique identifier of this resources within the entire dashboard. |
| DashboardResource | getDashboardResourceType() | String | Returns the Dashboard Resource Type as a string |
| DashboardResource | getFormula(formulaName) | Formula | Returns a Formula given the formula name. |
| DashboardResource | getFormulaNames() | Set | Returns a set of the names of all formulas for this object. |
| DashboardResource | getFormulas() | Map | Returns a map of all available formulas for this object. The key is the formula name. |
| TreePanelColumn | getHelp() | String | Returns the help text associated with the column. |
| TreePanelColumn | getId() | String | Returns the column id. |
| DashboardResource | getLRI() | String | Returns the Localized Resource Indicator (LRI) as a string. LRI is the unique identifier of this resource with the parent element. |
| TreePanelColumn | getName() | String | Returns the name of the column (i.e. Country, Population etc). |
| DashboardResource | getOwner() | DashboardResource | Returns the DashboardResource that owns this object. |
| TreePanelColumn | getWidth() | Integer | Returns the column width. |
| DashboardResource | invokeCallback(callbackName, args) | Object | Executes the specified callback definition and returns the result from the callback. |
| TreePanelColumn | isSelectable() | Boolean | Returns true if column is selectable, false otherwise. |
| DashboardResource | isTransient() | Boolean | Returns true if this is transient, false otherwise. Transient objects are not saved to the layout. |
| TreePanelColumn | setHeaderStyle(headerStyle) | Boolean | Sets the header style of the column. Able to set fonts,alignment,decoration,colors e.g: impact,right,italic,#ff0000 |
| TreePanelColumn | setWidth(columnWidth) | Object | Sets the width of the column in the TreePanel. |
| Object | toJson() | String | Returns a json representation of this object. |
Method Definitions¶
autosize()¶
Boolean TreePanelColumn::autosize()
Description¶
Autosizes this tree column. Returns true if operation is successful, false otherwise.
getCallback(callbackName)¶
Callback DashboardResource::getCallback(String callbackName)
Description¶
Returns a callback by name
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| callbackName | String | method name of callback |
getCallbacks()¶
Map DashboardResource::getCallbacks()
Description¶
Returns a map of all callback definitions.
getChildren()¶
List DashboardResource::getChildren()
Description¶
Returns a list of the child dashboard resources.
getClassName()¶
Description¶
Returns the string name of this object's class type.
getCssClass()¶
String TreePanelColumn::getCssClass()
Description¶
Returns the css class associated with the column.
getDRI()¶
String DashboardResource::getDRI()
Description¶
Returns the Dashboard Resource Indicator (DRI) as a string. DRI is the unique identifier of this resources within the entire dashboard.
getDashboardResourceType()¶
String DashboardResource::getDashboardResourceType()
Description¶
Returns the Dashboard Resource Type as a string
getFormula(formulaName)¶
Formula DashboardResource::getFormula(String formulaName)
Description¶
Returns a Formula given the formula name.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| formulaName | String | name of the formula to return |
getFormulaNames()¶
Set DashboardResource::getFormulaNames()
Description¶
Returns a set of the names of all formulas for this object.
getFormulas()¶
Map DashboardResource::getFormulas()
Description¶
Returns a map of all available formulas for this object. The key is the formula name.
getHelp()¶
String TreePanelColumn::getHelp()
Description¶
Returns the help text associated with the column.
getId()¶
String TreePanelColumn::getId()
Description¶
Returns the column id.
getLRI()¶
String DashboardResource::getLRI()
Description¶
Returns the Localized Resource Indicator (LRI) as a string. LRI is the unique identifier of this resource with the parent element.
getName()¶
String TreePanelColumn::getName()
Description¶
Returns the name of the column (i.e. Country, Population etc).
getOwner()¶
DashboardResource DashboardResource::getOwner()
Description¶
Returns the DashboardResource that owns this object.
getWidth()¶
Integer TreePanelColumn::getWidth()
Description¶
Returns the column width.
invokeCallback(callbackName,args)¶
Object DashboardResource::invokeCallback(String callbackName, Object ... args)
Description¶
Executes the specified callback definition and returns the result from the callback.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| callbackName | String | method name of callback |
| args | Object ... | arguments |
isSelectable()¶
Boolean TreePanelColumn::isSelectable()
Description¶
Returns true if column is selectable, false otherwise.
isTransient()¶
Boolean DashboardResource::isTransient()
Description¶
Returns true if this is transient, false otherwise. Transient objects are not saved to the layout.
setHeaderStyle(headerStyle)¶
Boolean TreePanelColumn::setHeaderStyle(String headerStyle)
Description¶
Sets the header style of the column. Able to set fonts,alignment,decoration,colors e.g: impact,right,italic,#ff0000
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| headerStyle | String |
setWidth(columnWidth)¶
Object TreePanelColumn::setWidth(Integer columnWidth)
Description¶
Sets the width of the column in the TreePanel.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| columnWidth | Integer | Width of the column, must not be negative |
toJson()¶
Description¶
Returns a json representation of this object.