com.smartgwt.client.widgets.cube
Class Facet

java.lang.Object
  com.smartgwt.client.core.JsObject
      com.smartgwt.client.core.DataClass
          com.smartgwt.client.core.RefDataClass
              com.smartgwt.client.widgets.cube.Facet

public class Facet
extends RefDataClass

Facet definition object made use of by the CubeGrid class.

Field Summary

Fields inherited from class com.smartgwt.client.core.JsObject

jsObj

Constructor Summary

Facet()

Facet(JavaScriptObject jsObj)

Facet(String id)

Facet(String id, String title)

Method Summary

Alignment	getAlign() Default alignment for facet label title, and cells for this facet.
String	getBorderAfter() CSS line style to apply as a border after this facet, eg "1px dashed blue"
String	getBorderBefore() CSS line style to apply as a border before this facet, eg "1px dashed blue"
Boolean	getCanCollapse() For tree facets, whether expand/collapse controls should be shown.
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
Boolean	getCollapsed() For tree facets, default collapse state for parent nodes
Object	getId() id of this facet.
Integer	getIdAsInt() id of this facet.
String	getIdAsString() id of this facet.
Boolean	getInlinedValues() When applied to a Chart, does the chart's data contain multiple values per record for this facet.
Boolean	getIsTree() Marks this facet as a hierarchical facet.
static Facet	getOrCreateRef(JavaScriptObject jsObj)
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
Boolean	getShowParentsLast() Indicates internal hierarchy should be displayed in reverse of normal tree order (so that parents follow children)
String	getSummaryTitle() Title for facet summary.
String	getSummaryValue() Value for facet summary.
Boolean	getSynchColumnLayout() If true, treat all values in this facet as a facetValueGroup - causes synched header reorder and resize.
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.
void	setAlign(Alignment align) Default alignment for facet label title, and cells for this facet.
void	setBorderAfter(String borderAfter) CSS line style to apply as a border after this facet, eg "1px dashed blue"
void	setBorderBefore(String borderBefore) CSS line style to apply as a border before this facet, eg "1px dashed blue"
void	setCanCollapse(Boolean canCollapse) For tree facets, whether expand/collapse controls should be shown.
void	setCanMinimize(Boolean canMinimize) If facet minimizing is enabled, whether this facet should show controls to minimize the next facet.
void	setCellAlign(Alignment cellAlign) Default alignment of cells (in the body) for this facet
void	setCollapsed(Boolean collapsed) For tree facets, default collapse state for parent nodes
void	setId(Integer id) id of this facet.
void	setId(String id) id of this facet.
void	setInlinedValues(Boolean inlinedValues) When applied to a Chart, does the chart's data contain multiple values per record for this facet.
void	setIsTree(Boolean isTree) Marks this facet as a hierarchical facet.
void	setRollupValue(String rollupValue) facetValueId of the rollup facetValue for this facet
void	setSelectionBoundary(SelectionBoundary selectionBoundary) Selection boundary determining what facets / facetValues can be selected together by drag selection / shift+click selection
void	setShowParentsLast(Boolean showParentsLast) Indicates internal hierarchy should be displayed in reverse of normal tree order (so that parents follow children)
void	setSummaryTitle(String summaryTitle) Title for facet summary.
void	setSummaryValue(String summaryValue) Value for facet summary.
void	setSynchColumnLayout(Boolean synchColumnLayout) If true, treat all values in this facet as a facetValueGroup - causes synched header reorder and resize.
void	setTitle(String title) User-visible title of this facet.
void	setTitleAlign(Alignment titleAlign) Alignment of facet label title
void	setValues(FacetValue... values) Array of facetValue definitions.
void	setWidth(int width) Integer number of pixels.

Methods inherited from class com.smartgwt.client.core.RefDataClass

getRef, getRef

Methods inherited from class com.smartgwt.client.core.DataClass

doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, getJsObj, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute

Methods inherited from class com.smartgwt.client.core.JsObject

isCreated, setJsObj

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Facet

public Facet()

Facet

public Facet(JavaScriptObject jsObj)

Facet

public Facet(String id)

Facet

public Facet(String id,
             String title)

Method Detail

getOrCreateRef

public static Facet getOrCreateRef(JavaScriptObject jsObj)

setAlign

public void setAlign(Alignment align)

Default alignment for facet label title, and cells for this facet. Can be overridden at the facetValue level, or by setting titleAlign or cellAlign on the facet.

Parameters:

align - align Default value is null

See Also:

setTitleAlign(com.smartgwt.client.types.Alignment), setCellAlign(com.smartgwt.client.types.Alignment)

getAlign

public Alignment getAlign()

Default alignment for facet label title, and cells for this facet. Can be overridden at the facetValue level, or by setting titleAlign or cellAlign on the facet.

Returns:

Alignment

See Also:

getTitleAlign(), getCellAlign()

setBorderAfter

public void setBorderAfter(String borderAfter)

CSS line style to apply as a border after this facet, eg "1px dashed blue"

Parameters:

borderAfter - borderAfter Default value is null

getBorderAfter

public String getBorderAfter()

CSS line style to apply as a border after this facet, eg "1px dashed blue"

Returns:

String

setBorderBefore

public void setBorderBefore(String borderBefore)

CSS line style to apply as a border before this facet, eg "1px dashed blue"

Parameters:

borderBefore - borderBefore Default value is null

getBorderBefore

public String getBorderBefore()

CSS line style to apply as a border before this facet, eg "1px dashed blue"

Returns:

String

setCanCollapse

public void setCanCollapse(Boolean canCollapse)

For tree facets, whether expand/collapse controls should be shown.

Parameters:

canCollapse - canCollapse Default value is facet.isTree

getCanCollapse

public Boolean getCanCollapse()

For tree facets, whether expand/collapse controls should be shown.

Returns:

Boolean

setCanMinimize

public void setCanMinimize(Boolean canMinimize)

If facet minimizing is enabled, whether this facet should show controls to minimize the next facet. Generally a tree facet should not also allow minimizing the next facet - the interaction of the two types of collapsing can be confusing.

See canMinimizeFacets.

Parameters:

canMinimize - canMinimize Default value is cubeGrid.canMinimizeFacets

getCanMinimize

public Boolean getCanMinimize()

If facet minimizing is enabled, whether this facet should show controls to minimize the next facet. Generally a tree facet should not also allow minimizing the next facet - the interaction of the two types of collapsing can be confusing.

See canMinimizeFacets.

Returns:

Boolean

setCellAlign

public void setCellAlign(Alignment cellAlign)

Default alignment of cells (in the body) for this facet

Parameters:

cellAlign - cellAlign Default value is cubeGrid.cellAlign

See Also:

CubeGrid.setCellAlign(com.smartgwt.client.types.Alignment)

getCellAlign

public Alignment getCellAlign()

Default alignment of cells (in the body) for this facet

Returns:

Alignment

See Also:

CubeGrid.getCellAlign()

setCollapsed

public void setCollapsed(Boolean collapsed)

For tree facets, default collapse state for parent nodes

Parameters:

collapsed - collapsed Default value is false

getCollapsed

public Boolean getCollapsed()

For tree facets, default collapse state for parent nodes

Returns:

Boolean

setInlinedValues

public void setInlinedValues(Boolean inlinedValues)

When applied to a Chart, does the chart's data contain multiple values per record for this facet. See data for a full overview of inlinedValues behavior.

Parameters:

inlinedValues - inlinedValues Default value is null

getInlinedValues

public Boolean getInlinedValues()

When applied to a Chart, does the chart's data contain multiple values per record for this facet. See data for a full overview of inlinedValues behavior.

Returns:

Boolean

setIsTree

public void setIsTree(Boolean isTree)

Marks this facet as a hierarchical facet.

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 collapsed.

Parameters:

isTree - isTree Default value is false

getIsTree

public Boolean getIsTree()

Marks this facet as a hierarchical facet.

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 collapsed.

Returns:

Boolean

setRollupValue

public void setRollupValue(String rollupValue)

facetValueId of the rollup facetValue for this facet

Parameters:

rollupValue - rollupValue Default value is cubeGrid.rollupValue

getRollupValue

public String getRollupValue()

facetValueId of the rollup facetValue for this facet

Returns:

String

setSelectionBoundary

public void setSelectionBoundary(SelectionBoundary selectionBoundary)

Selection boundary determining what facets / facetValues can be selected together by drag selection / shift+click selection

Parameters:

selectionBoundary - selectionBoundary Default value is null

getSelectionBoundary

public SelectionBoundary getSelectionBoundary()

Selection boundary determining what facets / facetValues can be selected together by drag selection / shift+click selection

Returns:

SelectionBoundary

setShowParentsLast

public void setShowParentsLast(Boolean showParentsLast)

Indicates internal hierarchy should be displayed in reverse of normal tree order (so that parents follow children)

Parameters:

showParentsLast - showParentsLast Default value is false

getShowParentsLast

public Boolean getShowParentsLast()

Indicates internal hierarchy should be displayed in reverse of normal tree order (so that parents follow children)

Returns:

Boolean

setSummaryTitle

public void setSummaryTitle(String summaryTitle)

Title for facet summary.

Parameters:

summaryTitle - summaryTitle Default value is cubeGrid.summaryTitle

getSummaryTitle

public String getSummaryTitle()

Title for facet summary.

Returns:

String

setSummaryValue

public void setSummaryValue(String summaryValue)

Value for facet summary.

Parameters:

summaryValue - summaryValue Default value is cubeGrid.summaryValue

getSummaryValue

public String getSummaryValue()

Value for facet summary.

Returns:

String

setSynchColumnLayout

public void setSynchColumnLayout(Boolean synchColumnLayout)

If true, treat all values in this facet as a facetValueGroup - causes synched header reorder and resize. Note: only supported when all of a facets values are used.

Parameters:

synchColumnLayout - synchColumnLayout Default value is true

getSynchColumnLayout

public Boolean getSynchColumnLayout()

If true, treat all values in this facet as a facetValueGroup - causes synched header reorder and resize. Note: only supported when all of a facets values are used.

Returns:

Boolean

setTitle

public void setTitle(String title)

User-visible title of this facet. Shown on the facet label in the CubeGrid.

Parameters:

title - title Default value is null

getTitle

public String getTitle()

User-visible title of this facet. Shown on the facet label in the CubeGrid.

Returns:

String

setTitleAlign

public void setTitleAlign(Alignment titleAlign)

Alignment of facet label title

Parameters:

titleAlign - titleAlign Default value is cubeGrid.facetTitleAlign

See Also:

CubeGrid.setFacetTitleAlign(com.smartgwt.client.types.Alignment)

getTitleAlign

public Alignment getTitleAlign()

Alignment of facet label title

Returns:

Alignment

See Also:

CubeGrid.getFacetTitleAlign()

setValues

public void setValues(FacetValue... values)

Array of facetValue definitions.

Parameters:

values - values Default value is null

See Also:

FacetValue

getValues

public FacetValue[] getValues()

Array of facetValue definitions.

Returns:

FacetValue

See Also:

FacetValue

setWidth

public void setWidth(int width)

Integer number of pixels. For row facets, width of headers.

Parameters:

width - width Default value is cubeGrid.defaultFacetWidth

See Also:

CubeGrid.setDefaultFacetWidth(int)

getWidth

public int getWidth()

Integer number of pixels. For row facets, width of headers.

Returns:

int

See Also:

CubeGrid.getDefaultFacetWidth()

setId

public void setId(Integer id)

id of this facet. Any string or number.

Parameters:

id - id Default value is null

setId

public void setId(String id)

id of this facet. Any string or number.

Parameters:

id - id Default value is null

getId

public Object getId()

id of this facet. Any string or number.

Parameters:

id - id Default value is null

getIdAsString

public String getIdAsString()

id of this facet. Any string or number.

Parameters:

id - id Default value is null

getIdAsInt

public Integer getIdAsInt()

id of this facet. Any string or number.

Parameters:

id - id Default value is null