/*
* Smart GWT (GWT for SmartClient)
* Copyright 2008 and beyond, Isomorphic Software, Inc.
*
* Smart GWT is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 3
* as published by the Free Software Foundation. Smart GWT is also
* available under typical commercial license terms - see
* http://smartclient.com/license
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*/
package com.smartgwt.client.widgets.cube;
import com.smartgwt.client.event.*;
import com.smartgwt.client.core.*;
import com.smartgwt.client.types.*;
import com.smartgwt.client.data.*;
import com.smartgwt.client.data.events.*;
import com.smartgwt.client.rpc.*;
import com.smartgwt.client.widgets.*;
import com.smartgwt.client.widgets.events.*;
import com.smartgwt.client.widgets.form.*;
import com.smartgwt.client.widgets.form.validator.*;
import com.smartgwt.client.widgets.form.fields.*;
import com.smartgwt.client.widgets.tile.*;
import com.smartgwt.client.widgets.tile.events.*;
import com.smartgwt.client.widgets.grid.*;
import com.smartgwt.client.widgets.grid.events.*;
import com.smartgwt.client.widgets.chart.*;
import com.smartgwt.client.widgets.layout.*;
import com.smartgwt.client.widgets.layout.events.*;
import com.smartgwt.client.widgets.menu.*;
import com.smartgwt.client.widgets.tab.*;
import com.smartgwt.client.widgets.toolbar.*;
import com.smartgwt.client.widgets.tree.*;
import com.smartgwt.client.widgets.tree.events.*;
import com.smartgwt.client.widgets.viewer.*;
import com.smartgwt.client.widgets.calendar.*;
import com.smartgwt.client.widgets.calendar.events.*;
import com.smartgwt.client.widgets.cube.*;
import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.HashMap;
import com.google.gwt.user.client.ui.Widget;
import com.google.gwt.core.client.JavaScriptObject;
import com.google.gwt.user.client.Element;
import com.smartgwt.client.util.*;
import com.google.gwt.event.shared.*;
import com.google.gwt.event.shared.HasHandlers;
/**
* Facet definition object made use of by the CubeGrid class.
*/
public class Facet extends RefDataClass {
public static Facet getOrCreateRef(JavaScriptObject jsObj) {
if(jsObj == null) return null;
RefDataClass obj = RefDataClass.getRef(jsObj);
if(obj != null) {
obj.setJsObj(jsObj);
return (Facet) obj;
} else {
return new Facet(jsObj);
}
}
public Facet(){
}
public Facet(JavaScriptObject jsObj){
super(jsObj);
}
public Facet(String id) {
setId(id);
}
public Facet(String id, String title) {
setId(id);
setTitle(title);
}
// ********************* Properties / Attributes ***********************
/**
* 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.
*
* @param align align Default value is null
* @see com.smartgwt.client.widgets.cube.Facet#setTitleAlign
* @see com.smartgwt.client.widgets.cube.Facet#setCellAlign
*/
public void setAlign(Alignment align) {
setAttribute("align", align == null ? null : align.getValue());
}
/**
* 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.
*
*
* @return Alignment
* @see com.smartgwt.client.widgets.cube.Facet#getTitleAlign
* @see com.smartgwt.client.widgets.cube.Facet#getCellAlign
*/
public Alignment getAlign() {
return EnumUtil.getEnum(Alignment.values(), getAttribute("align"));
}
/**
* CSS line style to apply as a border after this facet, eg "1px dashed blue"
*
* @param borderAfter borderAfter Default value is null
*/
public void setBorderAfter(String borderAfter) {
setAttribute("borderAfter", borderAfter);
}
/**
* CSS line style to apply as a border after this facet, eg "1px dashed blue"
*
*
* @return String
*/
public String getBorderAfter() {
return getAttributeAsString("borderAfter");
}
/**
* CSS line style to apply as a border before this facet, eg "1px dashed blue"
*
* @param borderBefore borderBefore Default value is null
*/
public void setBorderBefore(String borderBefore) {
setAttribute("borderBefore", borderBefore);
}
/**
* CSS line style to apply as a border before this facet, eg "1px dashed blue"
*
*
* @return String
*/
public String getBorderBefore() {
return getAttributeAsString("borderBefore");
}
/**
* For tree facets, whether expand/collapse controls should be shown.
*
* @param canCollapse canCollapse Default value is facet.isTree
*/
public void setCanCollapse(Boolean canCollapse) {
setAttribute("canCollapse", canCollapse);
}
/**
* For tree facets, whether expand/collapse controls should be shown.
*
*
* @return Boolean
*/
public Boolean getCanCollapse() {
return getAttributeAsBoolean("canCollapse");
}
/**
* 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.
* <P> See {@link com.smartgwt.client.widgets.cube.CubeGrid#getCanMinimizeFacets canMinimizeFacets}.
*
* @param canMinimize canMinimize Default value is cubeGrid.canMinimizeFacets
*/
public void setCanMinimize(Boolean canMinimize) {
setAttribute("canMinimize", 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.
* <P> See {@link com.smartgwt.client.widgets.cube.CubeGrid#getCanMinimizeFacets canMinimizeFacets}.
*
*
* @return Boolean
*/
public Boolean getCanMinimize() {
return getAttributeAsBoolean("canMinimize");
}
/**
* Default alignment of cells (in the body) for this facet
*
* @param cellAlign cellAlign Default value is cubeGrid.cellAlign
* @see com.smartgwt.client.widgets.cube.CubeGrid#setCellAlign
*/
public void setCellAlign(Alignment cellAlign) {
setAttribute("cellAlign", cellAlign == null ? null : cellAlign.getValue());
}
/**
* Default alignment of cells (in the body) for this facet
*
*
* @return Alignment
* @see com.smartgwt.client.widgets.cube.CubeGrid#getCellAlign
*/
public Alignment getCellAlign() {
return EnumUtil.getEnum(Alignment.values(), getAttribute("cellAlign"));
}
/**
* For tree facets, default collapse state for parent nodes
*
* @param collapsed collapsed Default value is false
*/
public void setCollapsed(Boolean collapsed) {
setAttribute("collapsed", collapsed);
}
/**
* For tree facets, default collapse state for parent nodes
*
*
* @return Boolean
*/
public Boolean getCollapsed() {
return getAttributeAsBoolean("collapsed");
}
/**
* 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 <code>inlinedValues</code> behavior.
*
* @param inlinedValues inlinedValues Default value is null
*/
public void setInlinedValues(Boolean inlinedValues) {
setAttribute("inlinedValues", 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 <code>inlinedValues</code> behavior.
*
*
* @return Boolean
*/
public Boolean getInlinedValues() {
return getAttributeAsBoolean("inlinedValues");
}
/**
* Marks this facet as a hierarchical facet. <P> If set, {@link com.smartgwt.client.widgets.cube.Facet#getValues
* facet.value} will be linked as for a {@link com.smartgwt.client.widgets.tree.Tree#getModelType modelType:"parent"} Tree,
* using {@link com.smartgwt.client.widgets.cube.FacetValue#getId facetValue.id} and {@link
* com.smartgwt.client.widgets.cube.FacetValue#getParentId facetValue.parentId}. Expand/collapse controls will be shown
* allowing navigation of the facet's values. <P> The CubeGrid's {@link
* com.smartgwt.client.widgets.cube.CubeGrid#getDataSource 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. <P> Initial open/close
* state can be controlled via {@link com.smartgwt.client.widgets.cube.Facet#getCollapsed facet.collapsed} and {@link
* com.smartgwt.client.widgets.cube.FacetValue#getCollapsed collapsed}.
*
* @param isTree isTree Default value is false
*/
public void setIsTree(Boolean isTree) {
setAttribute("isTree", isTree);
}
/**
* Marks this facet as a hierarchical facet. <P> If set, {@link com.smartgwt.client.widgets.cube.Facet#getValues
* facet.value} will be linked as for a {@link com.smartgwt.client.widgets.tree.Tree#getModelType modelType:"parent"} Tree,
* using {@link com.smartgwt.client.widgets.cube.FacetValue#getId facetValue.id} and {@link
* com.smartgwt.client.widgets.cube.FacetValue#getParentId facetValue.parentId}. Expand/collapse controls will be shown
* allowing navigation of the facet's values. <P> The CubeGrid's {@link
* com.smartgwt.client.widgets.cube.CubeGrid#getDataSource 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. <P> Initial open/close
* state can be controlled via {@link com.smartgwt.client.widgets.cube.Facet#getCollapsed facet.collapsed} and {@link
* com.smartgwt.client.widgets.cube.FacetValue#getCollapsed collapsed}.
*
*
* @return Boolean
*/
public Boolean getIsTree() {
return getAttributeAsBoolean("isTree");
}
/**
* facetValueId of the rollup facetValue for this facet
*
* @param rollupValue rollupValue Default value is cubeGrid.rollupValue
*/
public void setRollupValue(String rollupValue) {
setAttribute("rollupValue", rollupValue);
}
/**
* facetValueId of the rollup facetValue for this facet
*
*
* @return String
*/
public String getRollupValue() {
return getAttributeAsString("rollupValue");
}
/**
* Selection boundary determining what facets / facetValues can be selected together by drag selection / shift+click
* selection
*
* @param selectionBoundary selectionBoundary Default value is null
*/
public void setSelectionBoundary(SelectionBoundary selectionBoundary) {
setAttribute("selectionBoundary", selectionBoundary == null ? null : selectionBoundary.getValue());
}
/**
* Selection boundary determining what facets / facetValues can be selected together by drag selection / shift+click
* selection
*
*
* @return SelectionBoundary
*/
public SelectionBoundary getSelectionBoundary() {
return EnumUtil.getEnum(SelectionBoundary.values(), getAttribute("selectionBoundary"));
}
/**
* Indicates internal hierarchy should be displayed in reverse of normal tree order (so that parents follow children)
*
* @param showParentsLast showParentsLast Default value is false
*/
public void setShowParentsLast(Boolean showParentsLast) {
setAttribute("showParentsLast", showParentsLast);
}
/**
* Indicates internal hierarchy should be displayed in reverse of normal tree order (so that parents follow children)
*
*
* @return Boolean
*/
public Boolean getShowParentsLast() {
return getAttributeAsBoolean("showParentsLast");
}
/**
* Title for facet summary.
*
* @param summaryTitle summaryTitle Default value is cubeGrid.summaryTitle
*/
public void setSummaryTitle(String summaryTitle) {
setAttribute("summaryTitle", summaryTitle);
}
/**
* Title for facet summary.
*
*
* @return String
*/
public String getSummaryTitle() {
return getAttributeAsString("summaryTitle");
}
/**
* Value for facet summary.
*
* @param summaryValue summaryValue Default value is cubeGrid.summaryValue
*/
public void setSummaryValue(String summaryValue) {
setAttribute("summaryValue", summaryValue);
}
/**
* Value for facet summary.
*
*
* @return String
*/
public String getSummaryValue() {
return getAttributeAsString("summaryValue");
}
/**
* 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.
*
* @param synchColumnLayout synchColumnLayout Default value is true
*/
public void setSynchColumnLayout(Boolean synchColumnLayout) {
setAttribute("synchColumnLayout", 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.
*
*
* @return Boolean
*/
public Boolean getSynchColumnLayout() {
return getAttributeAsBoolean("synchColumnLayout");
}
/**
* User-visible title of this facet. Shown on the facet label in the CubeGrid.
*
* @param title title Default value is null
*/
public void setTitle(String title) {
setAttribute("title", title);
}
/**
* User-visible title of this facet. Shown on the facet label in the CubeGrid.
*
*
* @return String
*/
public String getTitle() {
return getAttributeAsString("title");
}
/**
* Alignment of facet label title
*
* @param titleAlign titleAlign Default value is cubeGrid.facetTitleAlign
* @see com.smartgwt.client.widgets.cube.CubeGrid#setFacetTitleAlign
*/
public void setTitleAlign(Alignment titleAlign) {
setAttribute("titleAlign", titleAlign == null ? null : titleAlign.getValue());
}
/**
* Alignment of facet label title
*
*
* @return Alignment
* @see com.smartgwt.client.widgets.cube.CubeGrid#getFacetTitleAlign
*/
public Alignment getTitleAlign() {
return EnumUtil.getEnum(Alignment.values(), getAttribute("titleAlign"));
}
/**
* Array of facetValue definitions.
*
* @param values values Default value is null
* @see com.smartgwt.client.widgets.cube.FacetValue
*/
public void setValues(FacetValue... values) {
setAttribute("values", values);
}
/**
* Array of facetValue definitions.
*
*
* @return FacetValue
* @see com.smartgwt.client.widgets.cube.FacetValue
*/
public FacetValue[] getValues() {
return FacetValue.convertToFacetValueArray(getAttributeAsJavaScriptObject("values"));
}
/**
* Integer number of pixels. For row facets, width of headers.
*
* @param width width Default value is cubeGrid.defaultFacetWidth
* @see com.smartgwt.client.widgets.cube.CubeGrid#setDefaultFacetWidth
*/
public void setWidth(int width) {
setAttribute("width", width);
}
/**
* Integer number of pixels. For row facets, width of headers.
*
*
* @return int
* @see com.smartgwt.client.widgets.cube.CubeGrid#getDefaultFacetWidth
*/
public int getWidth() {
return getAttributeAsInt("width");
}
// ********************* Methods ***********************
// ********************* Static Methods ***********************
// ***********************************************************
/**
* id of this facet. Any string or number.
*
* @param id id Default value is null
*/
public void setId(Integer id) {
setAttribute("id", id);
}
/**
* id of this facet. Any string or number.
*
* @param id id Default value is null
*/
public void setId(String id) {
setAttribute("id", id);
}
/**
* id of this facet. Any string or number.
*
* @param id id Default value is null
*/
public Object getId() {
return getAttributeAsObject("id");
}
/**
* id of this facet. Any string or number.
*
* @param id id Default value is null
*/
public String getIdAsString() {
return getAttributeAsString("id");
}
/**
* id of this facet. Any string or number.
*
* @param id id Default value is null
*/
public Integer getIdAsInt() {
return getAttributeAsInt("id");
}
}