|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectinetsoft.report.filter.HighlightGroup
public class HighlightGroup
HighLight expert group class. This class defines a HighLight Group.
| Nested Class Summary | |
|---|---|
static class |
HighlightGroup.HighlightAppliedEvent
Event that signals that a highlight was applied. |
static interface |
HighlightGroup.HighlightAppliedListener
Listener that is notified when a highlight has been applied. |
| Field Summary | |
|---|---|
static String |
DEFAULT_LEVEL
The name of the default binding level. |
| Constructor Summary | |
|---|---|
HighlightGroup()
Create an empty HighLightGroup. |
|
| Method Summary | |
|---|---|
void |
addHighlight(String name,
Highlight value)
Adds a highlight to the default level. |
void |
addHighlight(String level,
String name,
Highlight value)
Adds a highlight to the specified level. |
void |
addHighlightAppliedListener(HighlightGroup.HighlightAppliedListener l)
Adds a listener that is notified when a highlight is applied. |
Object |
clone()
Clone the highlight group. |
boolean |
equals(Object obj)
Check if equals another highlight group. |
Highlight |
findGroup(Object value)
Finds the highlight in the default level whose conditions match the specified value. |
Highlight |
findGroup(String level,
Object value)
Finds the highlight in the specified level whose conditions match the specified value. |
Highlight |
findGroup(String level,
TableLens lens,
int row)
Finds the highlight in the specified level whose conditions match a value in the specified row of a table. |
Highlight |
findGroup(String level,
TableLens lens,
int row,
int col)
Finds the highlight in the specified level whose conditions match a value in the specified cell of a table. |
Highlight |
findGroup(TableLens lens,
int row)
Finds the highlight in the default level whose conditions match a value in the specified row of a table. |
Highlight |
findGroup(TableLens lens,
int row,
int col)
Finds the highlight in the default level whose conditions match a value in the specified cell of a table. |
int |
getAllLevelsHighlightCount()
Gets the number of highlights applied to all levels in this group. |
UserVariable[] |
getAllVariables()
Gets all variables defined on the highlights in this group. |
Highlight |
getHighlight(String name)
Gets the highlight with the specified name from the default level. |
Highlight |
getHighlight(String level,
String name)
Gets the highlight with the specified name. |
int |
getHighlightCount()
Gets the number of highlights applied to the default level. |
int |
getHighlightCount(String level)
Gets the number of highlights applied to the specified level. |
int |
getLevelCount()
Gets the number of levels to which highlights have been applied. |
String[] |
getLevels()
Gets the names of the levels to which highlights have been applied. |
String[] |
getNames()
Gets the names of the highlights that are applied to the default level. |
String[] |
getNames(String level)
Gets the names of the highlights that are applied to the specified level. |
Object |
getQuerySandbox()
Getter of asset query sandbox. |
boolean |
isAllLevelsEmpty()
Determines if no highlights are applied to any level in this group. |
boolean |
isEmpty()
Determines if no highlights are applied to the default level. |
boolean |
isEmpty(String level)
Determines if no highlights are applied to the specified level. |
void |
moveHighlight(String level,
int idx1,
int idx2,
String name1,
String name2)
Exchange the positions of two specified highlight. |
void |
parseXML(Element tag)
Loads the properties of this object from an XML representation. |
void |
refresh()
Clears all cached condition data. |
void |
removeHighlight(String name)
Removes the named highlight from the default level. |
void |
removeHighlight(String level,
String name)
Removes the named highlight from the specified level. |
void |
removeHighlightAppliedListener(HighlightGroup.HighlightAppliedListener l)
Removes a listener from the notification list. |
void |
removeHighlights(String level)
Removes the highlights. |
void |
renameHighlight(String oname,
String nname,
Highlight lt)
Rename the highlight and keep the orders. |
void |
renameHighlight(String olevel,
String oname,
String nlevel,
String nname,
Highlight lt)
Rename the highlight and keep the orders. |
void |
replaceVariables(VariableTable vars)
Replaces the variable defined on the highlights with those provided. |
void |
setQuerySandbox(Object box)
Setter of asset query sandbox. |
String |
toString()
Get the string representation. |
void |
validate()
Validate the highlight group. |
void |
writeXML(PrintWriter writer)
Writes an XML representation of this object. |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final String DEFAULT_LEVEL
| Constructor Detail |
|---|
public HighlightGroup()
| Method Detail |
|---|
public void addHighlight(String name,
Highlight value)
name - the name of the highlight.value - the highlight definition.
public void addHighlight(String level,
String name,
Highlight value)
level - the level to which the highlight applies.name - the name of the highlight.value - the highlight definition.public Highlight getHighlight(String name)
name - the name of the highlight.
null if no such highlight
exists.
public Highlight getHighlight(String level,
String name)
level - the level to which the highlight applies.name - the name of the highlight.
null if no such highlight
exists.public int getHighlightCount()
public int getHighlightCount(String level)
level - the name of the level.
public int getAllLevelsHighlightCount()
public int getLevelCount()
public String[] getLevels()
public boolean isAllLevelsEmpty()
true if no highlights have been added;
false otherwise.public boolean isEmpty()
true if no highlights have been added;
false otherwise.public boolean isEmpty(String level)
level - the name of the level.
true if no highlights have been added;
false otherwise.public void removeHighlights(String level)
level - the name of the level.public void removeHighlight(String name)
name - the name of the highlight.
public void removeHighlight(String level,
String name)
level - the name of the level.name - the name of the highlight.
public void renameHighlight(String oname,
String nname,
Highlight lt)
oname - the old name of the highlight.nname - the new name of the highlight.lt - the highlight object.
public void renameHighlight(String olevel,
String oname,
String nlevel,
String nname,
Highlight lt)
olevel - the old level.oname - the old name of the highlight.nlevel - the new level.nname - the new name of the highlight.lt - the highlight object.
public void moveHighlight(String level,
int idx1,
int idx2,
String name1,
String name2)
idx1 - the first index.public String[] getNames()
public String[] getNames(String level)
level - the name of the level.
public Highlight findGroup(Object value)
value - the value to evaluate.
null if none match.
public Highlight findGroup(String level,
Object value)
level - the name of the level.value - the value to evaluate.
null if none match.
public Highlight findGroup(TableLens lens,
int row)
lens - the TableLens whose values to evaluate.row - the table row index to evaluate.
null if none match.
public Highlight findGroup(String level,
TableLens lens,
int row)
level - the name of the level.lens - the TableLens whose values will be evaluated.row - the table row index to evaluate.
null if none match.
public Highlight findGroup(TableLens lens,
int row,
int col)
lens - the TableLens whose values will be evaluated.row - the table row index of the value to evaluate.col - the table column index of the value to evaluate.
null if none match.
public Highlight findGroup(String level,
TableLens lens,
int row,
int col)
level - the name of the level.lens - the TableLens whose values will be evaluated.row - the table row index of the value to evaluate.col - the table column index of the value to evaluate.
null if none match.public void refresh()
public void validate()
public UserVariable[] getAllVariables()
public void replaceVariables(VariableTable vars)
vars - the new variable values.public void writeXML(PrintWriter writer)
writeXML in interface inetsoft.util.XMLSerializablewriter - the writer to which the XML will be written.
public void parseXML(Element tag)
throws Exception
parseXML in interface inetsoft.util.XMLSerializabletag - the XML representation of this object.
Exception - if an error occurs during parsing.public Object clone()
clone in class Objectpublic boolean equals(Object obj)
equals in class Objectpublic String toString()
toString in class Objectpublic Object getQuerySandbox()
public void setQuerySandbox(Object box)
public void addHighlightAppliedListener(HighlightGroup.HighlightAppliedListener l)
l - the listener to add.public void removeHighlightAppliedListener(HighlightGroup.HighlightAppliedListener l)
l - the listener to remove.
|
Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved. | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||