Style Intelligence v12.0

inetsoft.uql.asset
Interface WSAssembly

All Superinterfaces:
Assembly, AssetObject, Cloneable, Serializable, inetsoft.uql.asset.internal.VariableProvider, inetsoft.util.XMLSerializable
All Known Subinterfaces:
ConditionAssembly, DateRangeAssembly, NamedGroupAssembly, TableAssembly, VariableAssembly
All Known Implementing Classes:
AbstractTableAssembly, AbstractWSAssembly, BoundTableAssembly, ComposedTableAssembly, CompositeTableAssembly, ConcatenatedTableAssembly, CubeTableAssembly, DataTableAssembly, DefaultConditionAssembly, DefaultDateRangeAssembly, DefaultNamedGroupAssembly, DefaultVariableAssembly, EmbeddedTableAssembly, JoinTableAssembly, MirrorConditionAssembly, MirrorDateRangeAssembly, MirrorNamedGroupAssembly, MirrorTableAssembly, MirrorVariableAssembly, PhysicalBoundTableAssembly, QueryBoundTableAssembly, RotatedTableAssembly, SnapshotEmbeddedTableAssembly, UnpivotTableAssembly

public interface WSAssembly
extends Assembly, inetsoft.uql.asset.internal.VariableProvider

WSAssembly represents one assembly contained in a Worksheet, it should be one of the prefined type namely WorkSheet.CONDITION_ASSET, WorkSheet.NAMED_GROUP_ASSET, WorkSheet.VARIABLE_ASSET and WorkSheet.TABLE_ASSET. In its Worksheet, it will be laid out by its position and size and painted in the region.


Field Summary
 
Fields inherited from interface inetsoft.uql.asset.Assembly
CUBE_VS, DETAIL, EMBEDDED, FIELD, SELECTION, TABLE_VS
 
Method Summary
 void checkValidity()
          Check if the assembly is valid.
 WSAssembly copyAssembly(String name)
          Copy the assembly.
 String getDescription()
          Get the description.
 Worksheet getWorksheet()
          Get the worksheet.
 inetsoft.uql.asset.internal.WSAssemblyInfo getWSAssemblyInfo()
          Get the worksheet assembly info.
 boolean isComposed()
          Check if is composed.
 boolean isCondition()
          Check if is a condition assembly.
 boolean isDateCondition()
          Check if is a date condition assembly.
 boolean isIconized()
          Check if the assembly is iconized.
 boolean isNamedGroup()
          Check if is a named group assembly.
 boolean isOuter()
          Check if the assembly is outer.
 boolean isTable()
          Check if is a table assembly.
 boolean isVariable()
          Check if is a variable assembly.
 void replaceVariables(VariableTable vars)
          Replace all embeded user variables.
 void reset()
          Reset the assembly.
 void setDescription(String desc)
          Set the description.
 void setIconized(boolean iconized)
          Set iconized option.
 void setOuter(boolean outer)
          Set outer option.
 void setVisible(boolean visible)
          Set the visible flag.
 void setWorksheet(Worksheet ws)
          Set the worksheet.
 boolean update()
          Update the assembly.
 
Methods inherited from interface inetsoft.uql.asset.Assembly
addr, checkDependency, clone, getAbsoluteName, getAssemblyEntry, getAssemblyType, getBounds, getDependeds, getInfo, getMinimumSize, getName, getPosition, getSheet, getSize, isEditable, isVisible, renameDepended, setBounds, setPosition, setSize
 
Methods inherited from interface inetsoft.util.XMLSerializable
parseXML, writeXML
 
Methods inherited from interface inetsoft.uql.asset.internal.VariableProvider
getAllVariables
 

Method Detail

getWSAssemblyInfo

inetsoft.uql.asset.internal.WSAssemblyInfo getWSAssemblyInfo()
Get the worksheet assembly info.

Returns:
the worksheet assembly info.

isComposed

boolean isComposed()
Check if is composed.

Returns:
true if composed, false otherwise.

getDescription

String getDescription()
Get the description.

Returns:
the description of the assemmbly.

setDescription

void setDescription(String desc)
Set the description.

Parameters:
desc - the specified description.

isIconized

boolean isIconized()
Check if the assembly is iconized.

Returns:
true if iconized, false otherwise.

setIconized

void setIconized(boolean iconized)
Set iconized option.

Parameters:
iconized - true indicated iconized.

isOuter

boolean isOuter()
Check if the assembly is outer.

Returns:
true if outer, false otherwise.

setOuter

void setOuter(boolean outer)
Set outer option.

Parameters:
outer - true indicated outer.

checkValidity

void checkValidity()
                   throws Exception
Check if the assembly is valid.

Throws:
Exception

isCondition

boolean isCondition()
Check if is a condition assembly.

Returns:
true if yes, false otherwise.

isDateCondition

boolean isDateCondition()
Check if is a date condition assembly.

Returns:
true if yes, false otherwise.

isNamedGroup

boolean isNamedGroup()
Check if is a named group assembly.

Returns:
true if yes, false otherwise.

isVariable

boolean isVariable()
Check if is a variable assembly.

Returns:
true if yes, false otherwise.

isTable

boolean isTable()
Check if is a table assembly.

Returns:
true if yes, false otherwise.

setWorksheet

void setWorksheet(Worksheet ws)
Set the worksheet.

Parameters:
ws - the specified worksheet.

getWorksheet

Worksheet getWorksheet()
Get the worksheet.

Returns:
the worksheet of the assembly.

replaceVariables

void replaceVariables(VariableTable vars)
Replace all embeded user variables.

Parameters:
vars - the specified variable table.

update

boolean update()
Update the assembly.

Returns:
true if successful, false otherwise.

copyAssembly

WSAssembly copyAssembly(String name)
Copy the assembly.

Parameters:
name - the specified new assembly name.
Returns:
the copied assembly.

setVisible

void setVisible(boolean visible)
Set the visible flag.

Parameters:
visible - true if visible, false otherwise.

reset

void reset()
Reset the assembly.


Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.