com.smartgwt.client.widgets.cube
Class FacetValue

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

public class FacetValue
extends RefDataClass

Facet value definition object made use of by the CubeGrid class (contained by facets)

Field Summary

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

jsObj

Constructor Summary

FacetValue()

FacetValue(JavaScriptObject jsObj)

FacetValue(String id)

FacetValue(String id, String title)

FacetValue(String id, String title, String parentId)

Method Summary

static FacetValue[]	convertToFacetValueArray(JavaScriptObject nativeArray)
Alignment	getAlign() Default alignment for facet label title and cells for this facetValue.
String	getBorderAfter() CSS line style to apply as a border after this facetValue.
String	getBorderBefore() CSS line style to apply as a border before this facetValue.
Boolean	getCanCollapse() For individual parent facetValues within a hierarchical facet, this flag controls whether an expand/collapse control will be shown.
Boolean	getCanEdit() Whether cells for this facetValue can be edited.
Alignment	getCellAlign() Default alignment of cells (in the body) for this facetValue.
Boolean	getCollapsed() For tree facets, initial collapse state for this node.
Object	getId() id of this facetValue.
Integer	getIdAsInt() id of this facetValue.
String	getIdAsString() id of this facetValue.
Boolean	getIsMinimizeValue() Used to determine which facetValue is to be shown when the facet is minimized.
static FacetValue	getOrCreateRef(JavaScriptObject jsObj)
String	getParentId() For tree facets (facet.isTree), id of this facetValue's parent facetValue.
SelectionBoundary	getSelectionBoundary() Selection boundary determining what facets / facetValues can be selected together by drag selection / shift+click selection.
String	getTitle() User-visible title of this facetValue.
String	getTitleHilite() Hilite style to apply to the title for this facetValue.
int	getWidth() Width of the cube grid facetValue in pixels.
void	setAlign(Alignment align) Default alignment for facet label title and cells for this facetValue.
void	setBorderAfter(String borderAfter) CSS line style to apply as a border after this facetValue.
void	setBorderBefore(String borderBefore) CSS line style to apply as a border before this facetValue.
void	setCanCollapse(Boolean canCollapse) For individual parent facetValues within a hierarchical facet, this flag controls whether an expand/collapse control will be shown.
void	setCanEdit(Boolean canEdit) Whether cells for this facetValue can be edited.
void	setCellAlign(Alignment cellAlign) Default alignment of cells (in the body) for this facetValue.
void	setCollapsed(Boolean collapsed) For tree facets, initial collapse state for this node.
void	setId(Integer id) id of this facetValue.
void	setId(String id) id of this facetValue.
void	setIsMinimizeValue(Boolean isMinimizeValue) Used to determine which facetValue is to be shown when the facet is minimized.
void	setParentId(String parentId) For tree facets (facet.isTree), id of this facetValue's parent facetValue.
void	setSelectionBoundary(SelectionBoundary selectionBoundary) Selection boundary determining what facets / facetValues can be selected together by drag selection / shift+click selection.
void	setTitle(String title) User-visible title of this facetValue.
void	setTitleHilite(String titleHilite) Hilite style to apply to the title for this facetValue.
void	setWidth(int width) Width of the cube grid facetValue in 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

FacetValue

public FacetValue()

FacetValue

public FacetValue(JavaScriptObject jsObj)

FacetValue

public FacetValue(String id)

FacetValue

public FacetValue(String id,
                  String title)

FacetValue

public FacetValue(String id,
                  String title,
                  String parentId)

Method Detail

getOrCreateRef

public static FacetValue getOrCreateRef(JavaScriptObject jsObj)

setAlign

public void setAlign(Alignment align)

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

Parameters:

align - align Default value is null

getAlign

public Alignment getAlign()

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

Returns:

Alignment

setBorderAfter

public void setBorderAfter(String borderAfter)

CSS line style to apply as a border after this facetValue.

Parameters:

borderAfter - borderAfter Default value is null

getBorderAfter

public String getBorderAfter()

CSS line style to apply as a border after this facetValue.

Returns:

String

setBorderBefore

public void setBorderBefore(String borderBefore)

CSS line style to apply as a border before this facetValue.

Parameters:

borderBefore - borderBefore Default value is null

getBorderBefore

public String getBorderBefore()

CSS line style to apply as a border before this facetValue.

Returns:

String

setCanCollapse

public void setCanCollapse(Boolean canCollapse)

For individual parent facetValues within a hierarchical facet, this flag controls whether an expand/collapse control will be shown.

Parameters:

canCollapse - canCollapse Default value is true

getCanCollapse

public Boolean getCanCollapse()

For individual parent facetValues within a hierarchical facet, this flag controls whether an expand/collapse control will be shown.

Returns:

Boolean

setCanEdit

public void setCanEdit(Boolean canEdit)

Whether cells for this facetValue can be edited. Defaults to cubeGrid.canEdit

Parameters:

canEdit - canEdit Default value is cubeGrid.canEdit

getCanEdit

public Boolean getCanEdit()

Whether cells for this facetValue can be edited. Defaults to cubeGrid.canEdit

Returns:

Boolean

setCellAlign

public void setCellAlign(Alignment cellAlign)

Default alignment of cells (in the body) for this facetValue.

Parameters:

cellAlign - cellAlign Default value is facet.cellAlign

getCellAlign

public Alignment getCellAlign()

Default alignment of cells (in the body) for this facetValue.

Returns:

Alignment

setCollapsed

public void setCollapsed(Boolean collapsed)

For tree facets, initial collapse state for this node. Defaults to facet.collapsed.

Parameters:

collapsed - collapsed Default value is facet.collapsed

getCollapsed

public Boolean getCollapsed()

For tree facets, initial collapse state for this node. Defaults to facet.collapsed.

Returns:

Boolean

setIsMinimizeValue

public void setIsMinimizeValue(Boolean isMinimizeValue)

Used to determine which facetValue is to be shown when the facet is minimized.

See canMinimizeFacets.

Parameters:

isMinimizeValue - isMinimizeValue Default value is false

getIsMinimizeValue

public Boolean getIsMinimizeValue()

Used to determine which facetValue is to be shown when the facet is minimized.

See canMinimizeFacets.

Returns:

Boolean

setParentId

public void setParentId(String parentId)

For tree facets (facet.isTree), id of this facetValue's parent facetValue.

Note : This is an advanced setting

Parameters:

parentId - parentId Default value is null

getParentId

public String getParentId()

For tree facets (facet.isTree), id of this facetValue's parent facetValue.

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

setTitle

public void setTitle(String title)

User-visible title of this facetValue. Shown on the field header.

Parameters:

title - title Default value is null

getTitle

public String getTitle()

User-visible title of this facetValue. Shown on the field header.

Returns:

String

setTitleHilite

public void setTitleHilite(String titleHilite)

Hilite style to apply to the title for this facetValue. See hilites.

Parameters:

titleHilite - titleHilite Default value is null

getTitleHilite

public String getTitleHilite()

Hilite style to apply to the title for this facetValue. See hilites.

Returns:

String

setWidth

public void setWidth(int width)

Width of the cube grid facetValue in pixels.

Parameters:

width - width Default value is facet.width

getWidth

public int getWidth()

Width of the cube grid facetValue in pixels.

Returns:

int

setId

public void setId(Integer id)

id of this facetValue. Any string or number.

Parameters:

id - id Default value is null

setId

public void setId(String id)

id of this facetValue. Any string or number.

Parameters:

id - id Default value is null

getId

public Object getId()

id of this facetValue. Any string or number.

Parameters:

id - id Default value is null

getIdAsString

public String getIdAsString()

id of this facetValue. Any string or number.

Parameters:

id - id Default value is null

getIdAsInt

public Integer getIdAsInt()

id of this facetValue. Any string or number.

Parameters:

id - id Default value is null

convertToFacetValueArray

public static FacetValue[] convertToFacetValueArray(JavaScriptObject nativeArray)