public class ElementAttribute
extends java.lang.Object
Type | Property and Description |
---|---|
boolean |
isBusiness
Gets the value of the property businessProperty.
|
boolean |
isClient
Gets the value of the property clientProperty.
|
Constructor and Description |
---|
ElementAttribute() |
Modifier and Type | Method and Description |
---|---|
void |
addParam(java.lang.Object key,
java.lang.Object value)
Adds additional parameter by specified key.
|
java.lang.String |
getCategoryName()
Gets the category name of this property.
|
java.util.List |
getCategoryNames()
Gets a list of all categories name.
|
java.lang.String |
getClientPropertyKey()
Gets the client property key.
|
java.lang.String |
getDescription()
Gets the description text of this property which
displayed on property sheet component.
|
java.lang.String |
getDisplayName()
Gets the display name of this property.
|
javax.swing.table.TableCellEditor |
getEditor()
Gets the table cell editor for this property.
|
java.lang.String |
getEditorClass()
Gets the class name of the property editor.
|
java.awt.Color |
getFillColor()
Gets the fill color of this property.
|
int |
getFontStyle()
Gets the for font, that is the font style of this property.
|
java.awt.Color |
getForeColor()
Gets the for color, that is, the text color, of this property.
|
javax.swing.Icon |
getIcon()
Gets icon object of this property.
|
java.lang.Class |
getJavaClass()
Gets the property java class type.
|
java.lang.String |
getKey()
Gets the key of this element attribute.
|
int |
getMaxPackHeight()
Gets the maximal cell height for packing table rows.
|
int |
getMaxPackWidth()
Gets the maximum with value for packing.
|
int |
getMaxWidth()
Gets the max column width of this property.
|
int |
getMinPackHeight()
Gets the minimal cell height for packing table rows.
|
int |
getMinPackWidth()
Gets the minimum with value for packing.
|
int |
getMinWidth()
Gets the minimum column width of this property.
|
java.lang.String |
getName()
Gets the property name.
|
java.lang.Object |
getParam(java.lang.Object key)
Gets additional parameter by specified key.
|
java.util.Map |
getParams()
Gets the additional parameters of this properties.
|
java.lang.String |
getReadMethod()
Gets the read method name which used to read the property value.
|
javax.swing.table.TableCellRenderer |
getRenderer()
Gets the table cell renderer for this property.
|
java.lang.String |
getRendererClass()
Gets the class name of this property renderer.
|
java.util.Comparator |
getSortComparator()
Gets the comparator of this property.
|
java.lang.String |
getUserPropertyKey()
Gets the user property key.
|
int |
getWidth()
Gets the preferred column width of this property.
|
java.lang.String |
getWriteMethod()
Gets the write method name used to set value for this property.
|
boolean |
isBusinessProperty()
Gets the value of the property businessProperty.
|
boolean |
isClientProperty()
Gets the value of the property clientProperty.
|
boolean |
isEditable()
Tells TWaver whether this property is editable.
|
boolean |
isEnableBatch()
Tells TWaver whether this property is enable batch reading/writing.
|
boolean |
isExtraWidthAssignable()
Checks whether to be assigned extra with after packing.
|
boolean |
isRowPackParticipable()
Checks whether participate with packing table rows.
|
boolean |
isSortable()
Checks whether this attribute can be sorted.
|
boolean |
isVisible()
Checks whether this attribute is visible.
|
void |
setBusinessProperty(boolean businessProperty)
Sets whether this attribute is business property.
|
void |
setCategoryName(java.lang.String categoryName)
Sets the category name of this property.
|
void |
setCategoryNames(java.util.List categoryNames)
Sets a list of all categories name.
|
void |
setClientProperty(boolean clientProperty)
Deprecated.
whether or not clientProperty can be judged by clientPropertyKey.
|
void |
setClientPropertyKey(java.lang.String clientPropertyKey)
Sets the client property key.
|
void |
setDescription(java.lang.String description)
Sets the description text of this property which
displayed on property sheet component.
|
void |
setDisplayName(java.lang.String displayName)
Sets the display name of this property.
|
void |
setEditable(boolean editable)
Set whether this property is editable.
|
void |
setEditorClass(java.lang.String editorClass)
Sets the class name of the property editor.
|
void |
setEnableBatch(boolean enableBatch)
Sets whether this property is enable batch reading/writing.
|
void |
setExtraWidthAssignable(boolean extraWidthAssignable)
Sets whether to be assigned extra with after packing.
|
void |
setFillColor(java.awt.Color fillColor)
Sets the fill color of this property.
|
void |
setFontStyle(int fontStyle)
Sets the for font, that is the font style of this property.
|
void |
setForeColor(java.awt.Color foreColor)
Sets the for color, that is, the text color, of this property.
|
void |
setIcon(javax.swing.Icon icon)
Sets icon object of this property.
|
void |
setJavaClass(java.lang.Class javaClass)
Sets the property java class type.
|
void |
setMaxPackHeight(int maxPackHeight)
Sets the maximal cell height for packing table rows.
|
void |
setMaxPackWidth(int maxPackWidth)
Sets the maximum with value for packing.
|
void |
setMaxWidth(int maxWidth)
Sets the max column width of this property.
|
void |
setMinPackHeight(int minPackHeight)
Sets the minimal cell height for packing table rows.
|
void |
setMinPackWidth(int minPackWidth)
Sets the minimum with value for packing.
|
void |
setMinWidth(int minWidth)
Sets the minimum column width of this property.
|
void |
setName(java.lang.String name)
Sets the property name.
|
void |
setParams(java.util.Map params)
Sets the additional parameters of this properties.
|
void |
setReadMethod(java.lang.String readMethod)
Sets the read method name which used to read the property value.
|
void |
setRendererClass(java.lang.String rendererClass)
Sets the class name of this property renderer.
|
void |
setRowPackParticipable(boolean rowPackParticipable)
Sets whether this attribute will participate with packing table rows.
|
void |
setSortable(boolean sortable)
Sets whether this attribute can be sorted.
|
void |
setSortComparator(java.util.Comparator sortComparator)
Sets the comparator of this property.
|
void |
setUserPropertyKey(java.lang.String userPropertyKey)
Sets the user property key.
|
void |
setVisible(boolean visible)
Sets whether this attribute is visible.
|
void |
setWidth(int width)
Sets the preferred column width of this property.
|
void |
setWriteMethod(java.lang.String writeMethod)
Sets the write method name used to set value for this property.
|
public boolean isClientProperty
public boolean isBusinessProperty
public java.lang.String getName()
public void setName(java.lang.String name)
name
- String the new property name.public java.lang.Class getJavaClass()
public void setJavaClass(java.lang.Class javaClass)
javaClass
- Class the property java class type.public boolean isClientProperty()
public void setClientProperty(boolean clientProperty)
clientProperty
- boolean true if property is a client property, false otherwise.public javax.swing.table.TableCellRenderer getRenderer()
public javax.swing.table.TableCellEditor getEditor()
public java.lang.String getReadMethod()
setReadMethod(java.lang.String)
public void setReadMethod(java.lang.String readMethod)
readMethod
- String the read method name.getReadMethod()
public java.lang.String getWriteMethod()
setWriteMethod(java.lang.String)
public void setWriteMethod(java.lang.String writeMethod)
writeMethod
- String the write method name.getWriteMethod()
public boolean isEditable()
setEditable(boolean)
public void setEditable(boolean editable)
editable
- boolean true if editable, false otherwise.isEditable()
public boolean isEnableBatch()
public void setEnableBatch(boolean enableBatch)
enableBatch
- boolean true if this property
is enable batch reading/writing, false otherwise.public java.lang.String getClientPropertyKey()
#setClientPropertykey
public void setClientPropertyKey(java.lang.String clientPropertyKey)
clientPropertyKey
- String the client property key.getClientPropertyKey()
public java.lang.String getDisplayName()
setDisplayName(java.lang.String)
public void setDisplayName(java.lang.String displayName)
displayName
- String the property display name.getDisplayName()
public java.lang.String getCategoryName()
Please note if category set to null, then the property will be put into default "System" category.
setCategoryName(java.lang.String)
public void setCategoryName(java.lang.String categoryName)
Please note if category set to null, then the property will be put into default "System" category.
categoryName
- String the category name of this propertypublic java.util.Comparator getSortComparator()
setSortComparator(java.util.Comparator)
public void setSortComparator(java.util.Comparator sortComparator)
sortComparator
- Comparator the comparator object.getSortComparator()
public int getWidth()
setWidth(int)
public void setWidth(int width)
width
- int the preferred column width of this property.getWidth()
public int getMinWidth()
setMinWidth(int)
public void setMinWidth(int minWidth)
width
- int the minimum column width of this property.getMinWidth()
public int getMaxWidth()
setMaxWidth(int)
public void setMaxWidth(int maxWidth)
width
- int the max column width of this property.getMaxWidth()
public javax.swing.Icon getIcon()
By default icon is null.
setIcon(javax.swing.Icon)
public void setIcon(javax.swing.Icon icon)
icon
- Icon property icongetIcon()
public java.awt.Color getFillColor()
By default this color is null.
setFillColor(java.awt.Color)
public void setFillColor(java.awt.Color fillColor)
By default this color is null.
fillColor
- Color the property fill colorgetFillColor()
public java.awt.Color getForeColor()
By default this color is null.
setForeColor(java.awt.Color)
public void setForeColor(java.awt.Color foreColor)
foreColor
- Color the new fore color of this property.public java.lang.String getDescription()
setDescription(java.lang.String)
public void setDescription(java.lang.String description)
description
- String the description text of this property.public java.util.Map getParams()
<attribute clientPropertyKey="MyProp1" displayName="PropertyA" categoryName="mine"> <param key="minLength" value="5"/> <param key="message" value="PropertyA's min length is 5."/> </attribute>
setParams(java.util.Map)
public void setParams(java.util.Map params)
<attribute clientPropertyKey="MyProp1" displayName="PropertyA" categoryName="mine"> <param key="minLength" value="5"/> <param key="message" value="PropertyA's min length is 5."/> </attribute>
params
- Map all additional parameters of this property.getParams()
public java.lang.Object getParam(java.lang.Object key)
key
- Object parameter key.#setParam
,
setParams(java.util.Map)
,
getParams()
public void addParam(java.lang.Object key, java.lang.Object value)
key
- Object the parameter keyvalue
- Object the parameter valuegetParam(java.lang.Object)
,
getParams()
,
setParams(java.util.Map)
public java.lang.String getEditorClass()
setEditorClass(java.lang.String)
public void setEditorClass(java.lang.String editorClass)
editorClass
- String the editor class name.getEditorClass()
public java.lang.String getRendererClass()
setRendererClass(java.lang.String)
public void setRendererClass(java.lang.String rendererClass)
rendererClass
- String the renderer class name.getRendererClass()
public java.lang.String getKey()
public java.util.List getCategoryNames()
public void setCategoryNames(java.util.List categoryNames)
categoryNames
- List a list of all categories name.public int getFontStyle()
public void setFontStyle(int fontStyle)
fontStyle
- int the new font style of this property.
Legal values are:
TWaverConst.FONT_STYLE_DEFAULT
TWaverConst.FONT_STYLE_PLAIN
TWaverConst.FONT_STYLE_BOLD
TWaverConst.FONT_STYLE_ITALIC
TWaverConst.FONT_STYLE_ITALIC_BOLD
public boolean isSortable()
public void setSortable(boolean sortable)
sortable
- True to can be sorted, false otherwise.public boolean isVisible()
public void setVisible(boolean visible)
visible
- True to display, false to hide.public boolean isExtraWidthAssignable()
public void setExtraWidthAssignable(boolean extraWidthAssignable)
extraWidthAssignable
- True to be assigned, false otherwise.public int getMaxPackWidth()
public void setMaxPackWidth(int maxPackWidth)
maxPackWidth
- the maximum with value for packing.public int getMinPackWidth()
public void setMinPackWidth(int minPackWidth)
minPackWidth
- the minimum with value for packing.public boolean isRowPackParticipable()
public void setRowPackParticipable(boolean rowPackParticipable)
rowPackParticipable
- True to participate, false otherwise.public boolean isBusinessProperty()
public void setBusinessProperty(boolean businessProperty)
businessProperty
- True if business property, false otherwise.public java.lang.String getUserPropertyKey()
public void setUserPropertyKey(java.lang.String userPropertyKey)
userPropertyKey
- the user property key.public int getMaxPackHeight()
public void setMaxPackHeight(int maxPackHeight)
maxPackHeight
- the maximal cell height for packing table rows.public int getMinPackHeight()
public void setMinPackHeight(int minPackHeight)
minPackHeight
- the minimal cell height for packing table rows.Copyright © 2002 - 2010 Serva Software. All Rights Reserved.