public class Category
extends java.lang.Object
implements java.lang.Cloneable
This class is also works as a category manager to manage all TWaver categories. Category has no constructors, you have to create and manage categories with the static methods defined in this class.
Modifier and Type | Field and Description |
---|---|
static java.util.Comparator |
DISPLAYNAME_COMPARATOR
The predefined comparator for comparing display name.
|
static java.util.Comparator |
INDEX_COMPARATOR
The predefined comparator for comparing index.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone() |
boolean |
equals(java.lang.Object obj) |
static java.util.List |
getAllCategories()
Gets all registered categories.
|
static Category |
getCategory(java.lang.String name)
Get a registered category by category name
|
java.lang.String |
getDescription()
Get category description
|
java.lang.String |
getDisplayName()
Get display name of this category.
|
java.lang.String |
getName()
Get category name
|
int |
hashCode() |
boolean |
isExpand()
Check whether this category should be expanded when displayed in
a property sheet component.
|
static void |
registerCategory(java.lang.String name,
java.lang.String displayName)
Register a category.
|
static void |
registerCategory(java.lang.String name,
java.lang.String displayName,
boolean isExpand)
Register a category.
|
static void |
registerCategory(java.lang.String name,
java.lang.String displayName,
java.lang.String description)
Register a category.
|
static void |
registerCategory(java.lang.String name,
java.lang.String displayName,
java.lang.String description,
boolean isExpand)
Register a category.
|
void |
setDescription(java.lang.String description)
Set category description
|
void |
setDisplayName(java.lang.String displayName)
Set display name for this category.
|
void |
setExpand(boolean isExpand)
Set whether this category should be expanded when displayed
in a property sheet component.
|
void |
setName(java.lang.String name)
Set category name
|
java.lang.String |
toString()
Override this method to return category display
name as the "toString" value
|
public static final java.util.Comparator INDEX_COMPARATOR
public static final java.util.Comparator DISPLAYNAME_COMPARATOR
public static java.util.List getAllCategories()
public static void registerCategory(java.lang.String name, java.lang.String displayName)
name
- String category namedisplayName
- String category display namepublic static void registerCategory(java.lang.String name, java.lang.String displayName, boolean isExpand)
name
- String category namedisplayName
- String category display nameisExpand
- boolean true if category is expand in property sheet,
false otherwisepublic static void registerCategory(java.lang.String name, java.lang.String displayName, java.lang.String description)
name
- String category namedisplayName
- String category display namedescription
- String category description
false otherwisepublic static void registerCategory(java.lang.String name, java.lang.String displayName, java.lang.String description, boolean isExpand)
name
- String category namedisplayName
- String category display namedescription
- String category descriptionisExpand
- boolean true if category is expand in property sheet,
false otherwisepublic static Category getCategory(java.lang.String name)
name
- String category namepublic java.lang.String getDisplayName()
setDisplayName(java.lang.String)
public void setDisplayName(java.lang.String displayName)
displayName
- String the display name of this category.getDisplayName()
public boolean isExpand()
setExpand(boolean)
public void setExpand(boolean isExpand)
isExpand
- boolean true if expand, false otherwiseisExpand
public java.lang.String getName()
setName(java.lang.String)
public void setName(java.lang.String name)
name
- String the category namegetName()
public java.lang.String getDescription()
setDescription(java.lang.String)
public void setDescription(java.lang.String description)
description
- String category descriptiongetDescription()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
obj
- Objectpublic int hashCode()
hashCode
in class java.lang.Object
public java.lang.Object clone()
clone
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
Copyright © 2002 - 2010 Serva Software. All Rights Reserved.