public class Facet extends RefDataClass
CubeGrid
and FacetChart
classes.id
factoryCreated, factoryProperties
Constructor and Description |
---|
Facet() |
Facet(com.google.gwt.core.client.JavaScriptObject jsObj) |
Facet(java.lang.String id) |
Facet(java.lang.String id,
java.lang.String title) |
Modifier and Type | Method and Description |
---|---|
Alignment |
getAlign()
Default alignment for facet label title, and cells for this facet.
|
java.lang.String |
getBorderAfter()
CSS line style to apply as a border after this facet, eg "1px dashed blue"
|
java.lang.String |
getBorderBefore()
CSS line style to apply as a border before this facet, eg "1px dashed blue"
|
java.lang.Boolean |
getCanCollapse()
For tree facets, whether expand/collapse controls should be shown.
|
java.lang.Boolean |
getCanMinimize()
If facet minimizing is enabled, whether this facet should show controls to minimize the next facet.
|
Alignment |
getCellAlign()
Default alignment of cells (in the body) for this facet.
|
java.lang.Boolean |
getCollapsed()
For tree facets, default collapse state for parent nodes.
|
java.lang.Integer |
getHeight()
Integer number of pixels.
|
java.lang.Object |
getId()
id of this facet.
|
java.lang.Integer |
getIdAsInt()
id of this facet.
|
java.lang.String |
getIdAsString()
id of this facet.
|
java.lang.Boolean |
getIndentVTree()
Controls indenting for a
hierarchical column facet if set
non-null, overrriding the value of CubeGrid.indentVTreeFacets . |
java.lang.Boolean |
getInlinedValues()
When applied to a Chart, does the chart's data contain multiple values per record for this facet.
|
java.lang.Boolean |
getIsTree()
Marks this facet as a hierarchical facet.
|
java.lang.Integer |
getLabelHeight()
Integer number of pixels.
|
java.lang.Boolean |
getMinimized()
Default
minimize state for parent nodes. |
static Facet |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.String |
getProportionalTitle()
For
FacetCharts only, this property specifies the value axis label
when a FacetChart is in proportional rendering mode
and has this facet as its legend facet . |
java.lang.String |
getRollupValue()
facetValueId of the rollup facetValue for this facet.
|
SelectionBoundary |
getSelectionBoundary()
Selection boundary determining what facets / facetValues can be selected together by drag selection / shift+click
selection.
|
java.lang.Boolean |
getSeparateFolders()
Should folders in the facet tree be sorted separately from leaves or should the facet values retain their data order
regardless of whether a value is a leaf or folder in the tree?
|
java.lang.Boolean |
getShowParentsLast()
Indicates internal hierarchy should be displayed in reverse of normal tree order (so that parents follow children).
|
java.lang.Boolean |
getSortFoldersBeforeLeaves()
If
separateFolders is true, should folders be
displayed above or below leaves? When set to true folders will appear above leaves unless the data order
has been reversed by setting showParentsLast to
true . |
java.lang.String |
getSummaryTitle()
Title for facet summary.
|
java.lang.String |
getSummaryValue()
Value for facet summary.
|
java.lang.Boolean |
getSynchColumnLayout()
If true, treat all values in this facet as a facetValueGroup - causes synched header reorder and resize.
|
java.lang.String |
getTitle()
User-visible title of this facet.
|
Alignment |
getTitleAlign()
Alignment of facet label title.
|
FacetValue[] |
getValues()
Array of facetValue definitions.
|
int |
getWidth()
Integer number of pixels.
|
Facet |
setAlign(Alignment align)
Default alignment for facet label title, and cells for this facet.
|
Facet |
setBorderAfter(java.lang.String borderAfter)
CSS line style to apply as a border after this facet, eg "1px dashed blue"
|
Facet |
setBorderBefore(java.lang.String borderBefore)
CSS line style to apply as a border before this facet, eg "1px dashed blue"
|
Facet |
setCanCollapse(java.lang.Boolean canCollapse)
For tree facets, whether expand/collapse controls should be shown.
|
Facet |
setCanMinimize(java.lang.Boolean canMinimize)
If facet minimizing is enabled, whether this facet should show controls to minimize the next facet.
|
Facet |
setCellAlign(Alignment cellAlign)
Default alignment of cells (in the body) for this facet.
|
Facet |
setCollapsed(java.lang.Boolean collapsed)
For tree facets, default collapse state for parent nodes.
|
Facet |
setHeight(java.lang.Integer height)
Integer number of pixels.
|
void |
setId(java.lang.Integer id)
id of this facet.
|
void |
setId(java.lang.String id)
id of this facet.
|
Facet |
setIndentVTree(java.lang.Boolean indentVTree)
Controls indenting for a
hierarchical column facet if set
non-null, overrriding the value of CubeGrid.indentVTreeFacets . |
Facet |
setInlinedValues(java.lang.Boolean inlinedValues)
When applied to a Chart, does the chart's data contain multiple values per record for this facet.
|
Facet |
setIsTree(java.lang.Boolean isTree)
Marks this facet as a hierarchical facet.
|
Facet |
setLabelHeight(java.lang.Integer labelHeight)
Integer number of pixels.
|
Facet |
setMinimized(java.lang.Boolean minimized)
Default
minimize state for parent nodes. |
Facet |
setProportionalTitle(java.lang.String proportionalTitle)
For
FacetCharts only, this property specifies the value axis label
when a FacetChart is in proportional rendering mode
and has this facet as its legend facet . |
Facet |
setRollupValue(java.lang.String rollupValue)
facetValueId of the rollup facetValue for this facet.
|
Facet |
setSelectionBoundary(SelectionBoundary selectionBoundary)
Selection boundary determining what facets / facetValues can be selected together by drag selection / shift+click
selection.
|
Facet |
setSeparateFolders(java.lang.Boolean separateFolders)
Should folders in the facet tree be sorted separately from leaves or should the facet values retain their data order
regardless of whether a value is a leaf or folder in the tree?
|
Facet |
setShowParentsLast(java.lang.Boolean showParentsLast)
Indicates internal hierarchy should be displayed in reverse of normal tree order (so that parents follow children).
|
Facet |
setSortFoldersBeforeLeaves(java.lang.Boolean sortFoldersBeforeLeaves)
If
separateFolders is true, should folders be
displayed above or below leaves? When set to true folders will appear above leaves unless the data order
has been reversed by setting showParentsLast to
true . |
Facet |
setSummaryTitle(java.lang.String summaryTitle)
Title for facet summary.
|
Facet |
setSummaryValue(java.lang.String summaryValue)
Value for facet summary.
|
Facet |
setSynchColumnLayout(java.lang.Boolean synchColumnLayout)
If true, treat all values in this facet as a facetValueGroup - causes synched header reorder and resize.
|
Facet |
setTitle(java.lang.String title)
User-visible title of this facet.
|
Facet |
setTitleAlign(Alignment titleAlign)
Alignment of facet label title.
|
Facet |
setValues(FacetValue... values)
Array of facetValue definitions.
|
Facet |
setWidth(int width)
Integer number of pixels.
|
getRef, getRef, internalSetID
applyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated
public Facet()
public Facet(com.google.gwt.core.client.JavaScriptObject jsObj)
public Facet(java.lang.String id)
public Facet(java.lang.String id, java.lang.String title)
public static Facet getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public Facet setAlign(Alignment align)
Note: This property is specific to CubeGrids
(see, for example, CubeGrid.facetValueAlign
).
align
- New align value. Default value is nullFacet
instance, for chaining setter callssetTitleAlign(com.smartgwt.client.types.Alignment)
,
setCellAlign(com.smartgwt.client.types.Alignment)
public Alignment getAlign()
Note: This property is specific to CubeGrids
(see, for example, CubeGrid.facetValueAlign
).
getTitleAlign()
,
getCellAlign()
public Facet setBorderAfter(java.lang.String borderAfter)
Note: This property is specific
to CubeGrids
.
borderAfter
- New borderAfter value. Default value is nullFacet
instance, for chaining setter callspublic java.lang.String getBorderAfter()
Note: This property is specific
to CubeGrids
.
public Facet setBorderBefore(java.lang.String borderBefore)
Note: This property is specific
to CubeGrids
.
borderBefore
- New borderBefore value. Default value is nullFacet
instance, for chaining setter callspublic java.lang.String getBorderBefore()
Note: This property is specific
to CubeGrids
.
public Facet setCanCollapse(java.lang.Boolean canCollapse)
Note: This property is specific to CubeGrids
(see, for example, CubeGrid.canCollapseFacets
).
canCollapse
- New canCollapse value. Default value is facet.isTreeFacet
instance, for chaining setter callspublic java.lang.Boolean getCanCollapse()
Note: This property is specific to CubeGrids
(see, for example, CubeGrid.canCollapseFacets
).
public Facet setCanMinimize(java.lang.Boolean canMinimize)
Note: This property is specific to CubeGrids
. See CubeGrid.canMinimizeFacets
.
canMinimize
- New canMinimize value. Default value is cubeGrid.canMinimizeFacetsFacet
instance, for chaining setter callspublic java.lang.Boolean getCanMinimize()
Note: This property is specific to CubeGrids
. See CubeGrid.canMinimizeFacets
.
public Facet setCellAlign(Alignment cellAlign)
Note: This property is specific to CubeGrids
.
cellAlign
- New cellAlign value. Default value is cubeGrid.cellAlignFacet
instance, for chaining setter callsCubeGrid.setCellAlign(com.smartgwt.client.types.Alignment)
public Alignment getCellAlign()
Note: This property is specific to CubeGrids
.
CubeGrid.getCellAlign()
public Facet setCollapsed(java.lang.Boolean collapsed)
Note: This property is specific to CubeGrids
.
collapsed
- New collapsed value. Default value is falseFacet
instance, for chaining setter callspublic java.lang.Boolean getCollapsed()
Note: This property is specific to CubeGrids
.
public Facet setHeight(java.lang.Integer height)
If this
property conflicts with a labelHeight
, the greater of the
two properties will be used for determining the height of the affected row.
Note: This property is specific
to CubeGrids
.
height
- New height value. Default value is nullFacet
instance, for chaining setter callspublic java.lang.Integer getHeight()
If this
property conflicts with a labelHeight
, the greater of the
two properties will be used for determining the height of the affected row.
Note: This property is specific
to CubeGrids
.
public Facet setIndentVTree(java.lang.Boolean indentVTree)
hierarchical
column facet if set
non-null, overrriding the value of CubeGrid.indentVTreeFacets
.indentVTree
- New indentVTree value. Default value is nullFacet
instance, for chaining setter callsCubeGrid.setVTreeFacetIndentDirection(com.smartgwt.client.types.FacetIndentDirection)
public java.lang.Boolean getIndentVTree()
hierarchical
column facet if set
non-null, overrriding the value of CubeGrid.indentVTreeFacets
.CubeGrid.getVTreeFacetIndentDirection()
public Facet setInlinedValues(java.lang.Boolean inlinedValues)
inlinedValues
behavior.inlinedValues
- New inlinedValues value. Default value is nullFacet
instance, for chaining setter callspublic java.lang.Boolean getInlinedValues()
inlinedValues
behavior.public Facet setIsTree(java.lang.Boolean isTree)
If set, facet.value
will be linked as for a modelType:"parent"
Tree,
using facetValue.id
and facetValue.parentId
. Expand/collapse controls will be shown
allowing navigation of the facet's values.
The CubeGrid's load on demand
system automatically avoids fetching data for
facetValues that are not currently visible due to the expand/collapse state of a tree facet.
Initial open/close
state can be controlled via facet.collapsed
and FacetValue.collapsed
.
Note: This property is
specific to CubeGrids
.
isTree
- New isTree value. Default value is falseFacet
instance, for chaining setter callssetShowParentsLast(java.lang.Boolean)
,
setSeparateFolders(java.lang.Boolean)
public java.lang.Boolean getIsTree()
If set, facet.value
will be linked as for a modelType:"parent"
Tree,
using facetValue.id
and facetValue.parentId
. Expand/collapse controls will be shown
allowing navigation of the facet's values.
The CubeGrid's load on demand
system automatically avoids fetching data for
facetValues that are not currently visible due to the expand/collapse state of a tree facet.
Initial open/close
state can be controlled via facet.collapsed
and FacetValue.collapsed
.
Note: This property is
specific to CubeGrids
.
getShowParentsLast()
,
getSeparateFolders()
public Facet setLabelHeight(java.lang.Integer labelHeight)
If this property conflicts with a height
, the greater of the two properties will be used for determining
the height of the affected row.
Note: This property is specific to CubeGrids
.
labelHeight
- New labelHeight value. Default value is nullFacet
instance, for chaining setter callspublic java.lang.Integer getLabelHeight()
If this property conflicts with a height
, the greater of the two properties will be used for determining
the height of the affected row.
Note: This property is specific to CubeGrids
.
public Facet setMinimized(java.lang.Boolean minimized)
minimize state
for parent nodes.
Note: This property is specific to CubeGrids
.
minimized
- New minimized value. Default value is falseFacet
instance, for chaining setter callspublic java.lang.Boolean getMinimized()
minimize state
for parent nodes.
Note: This property is specific to CubeGrids
.
public Facet setProportionalTitle(java.lang.String proportionalTitle)
FacetCharts
only, this property specifies the value axis label
when a FacetChart is in proportional rendering mode
and has this facet as its legend facet
. If the
proportionalTitle
is not specified then FacetChart.proportionalAxisLabel
is used as the
default title.proportionalTitle
- New proportionalTitle value. Default value is nullFacet
instance, for chaining setter callspublic java.lang.String getProportionalTitle()
FacetCharts
only, this property specifies the value axis label
when a FacetChart is in proportional rendering mode
and has this facet as its legend facet
. If the
proportionalTitle
is not specified then FacetChart.proportionalAxisLabel
is used as the
default title.public Facet setRollupValue(java.lang.String rollupValue)
Note: This property is specific to CubeGrids
. See CubeGrid.rollupValue
.
rollupValue
- New rollupValue value. Default value is cubeGrid.rollupValueFacet
instance, for chaining setter callspublic java.lang.String getRollupValue()
Note: This property is specific to CubeGrids
. See CubeGrid.rollupValue
.
public Facet setSelectionBoundary(SelectionBoundary selectionBoundary)
Note: This property is specific to CubeGrids
.
selectionBoundary
- New selectionBoundary value. Default value is nullFacet
instance, for chaining setter callspublic SelectionBoundary getSelectionBoundary()
Note: This property is specific to CubeGrids
.
public Facet setSeparateFolders(java.lang.Boolean separateFolders)
separateFolders
- New separateFolders value. Default value is falseFacet
instance, for chaining setter callssetShowParentsLast(java.lang.Boolean)
,
setSortFoldersBeforeLeaves(java.lang.Boolean)
public java.lang.Boolean getSeparateFolders()
getShowParentsLast()
,
getSortFoldersBeforeLeaves()
public Facet setShowParentsLast(java.lang.Boolean showParentsLast)
Note: This property is specific to CubeGrids
.
showParentsLast
- New showParentsLast value. Default value is falseFacet
instance, for chaining setter callspublic java.lang.Boolean getShowParentsLast()
Note: This property is specific to CubeGrids
.
public Facet setSortFoldersBeforeLeaves(java.lang.Boolean sortFoldersBeforeLeaves)
separateFolders
is true, should folders be
displayed above or below leaves? When set to true
folders will appear above leaves unless the data order
has been reversed by setting showParentsLast
to
true
.sortFoldersBeforeLeaves
- New sortFoldersBeforeLeaves value. Default value is trueFacet
instance, for chaining setter callspublic java.lang.Boolean getSortFoldersBeforeLeaves()
separateFolders
is true, should folders be
displayed above or below leaves? When set to true
folders will appear above leaves unless the data order
has been reversed by setting showParentsLast
to
true
.public Facet setSummaryTitle(java.lang.String summaryTitle)
Note: This property is specific to CubeGrids
.
summaryTitle
- New summaryTitle value. Default value is cubeGrid.summaryTitleFacet
instance, for chaining setter callspublic java.lang.String getSummaryTitle()
Note: This property is specific to CubeGrids
.
public Facet setSummaryValue(java.lang.String summaryValue)
Note: This property is specific to CubeGrids
.
summaryValue
- New summaryValue value. Default value is cubeGrid.summaryValueFacet
instance, for chaining setter callspublic java.lang.String getSummaryValue()
Note: This property is specific to CubeGrids
.
public Facet setSynchColumnLayout(java.lang.Boolean synchColumnLayout)
Note: This property is specific to CubeGrids
and is only
supported when all of a facet's values are used.
synchColumnLayout
- New synchColumnLayout value. Default value is trueFacet
instance, for chaining setter callspublic java.lang.Boolean getSynchColumnLayout()
Note: This property is specific to CubeGrids
and is only
supported when all of a facet's values are used.
public Facet setTitle(java.lang.String title)
title
- New title value. Default value is nullFacet
instance, for chaining setter callspublic java.lang.String getTitle()
public Facet setTitleAlign(Alignment titleAlign)
Note: This property is specific to CubeGrids
.
titleAlign
- New titleAlign value. Default value is cubeGrid.facetTitleAlignFacet
instance, for chaining setter callsCubeGrid.setFacetTitleAlign(com.smartgwt.client.types.Alignment)
public Alignment getTitleAlign()
Note: This property is specific to CubeGrids
.
CubeGrid.getFacetTitleAlign()
public Facet setValues(FacetValue... values)
values
- New values value. Default value is nullFacet
instance, for chaining setter callsFacetValue
public FacetValue[] getValues()
FacetValue
public Facet setWidth(int width)
Note: This property is specific to CubeGrids
.
width
- New width value. Default value is cubeGrid.defaultFacetWidthFacet
instance, for chaining setter callsCubeGrid.setDefaultFacetWidth(int)
public int getWidth()
Note: This property is specific to CubeGrids
.
CubeGrid.getDefaultFacetWidth()
public void setId(java.lang.Integer id)
id
- id Default value is nullpublic void setId(java.lang.String id)
id
- id Default value is nullpublic java.lang.Object getId()
id
- id Default value is nullpublic java.lang.String getIdAsString()
id
- id Default value is nullpublic java.lang.Integer getIdAsInt()
id
- id Default value is null