|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.smartgwt.client.core.JsObject
com.smartgwt.client.core.DataClass
com.smartgwt.client.widgets.viewer.DetailViewerField
public class DetailViewerField
An object literal with a particular set of properties used to configure the display of
and interaction with the rows of a DetailViewer
.
Field Summary |
---|
Fields inherited from class com.smartgwt.client.core.JsObject |
---|
jsObj |
Constructor Summary | |
---|---|
DetailViewerField()
|
|
DetailViewerField(com.google.gwt.core.client.JavaScriptObject jsObj)
|
|
DetailViewerField(java.lang.String name)
|
|
DetailViewerField(java.lang.String name,
java.lang.String title)
|
Method Summary | |
---|---|
java.lang.String |
getCellStyle()
Return the cellStyle. |
java.lang.Integer |
getHeight()
For type : "separator" , this attribute specifies
the height of the separator. |
java.lang.Integer |
getImageHeight()
Height of image shown for fieldTypes image in this field. |
java.lang.Integer |
getImageSize()
Size of images shown for fieldTypes image in this field. |
java.lang.String |
getImageURLPrefix()
If this field has type set to "image"
and the URL for the image displayed is not absolute, the path of the URL will be relative
to this string |
java.lang.Integer |
getImageWidth()
Width of images shown for fieldTypes image in this field. |
java.lang.String |
getName()
|
static DetailViewerField |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
|
java.lang.String |
getTitle()
The title of the field as displayed on the left-hand side. |
java.lang.String |
getType()
Specifies the type of this DetailViewerField. |
java.lang.String |
getValue()
When a field specifies its type to be "header", the value of
this attribute specifies the header text. |
void |
setCellStyle(java.lang.String cellStyle)
Set the cellStyle. |
void |
setCellStyleHandler(CellStyleHandler handler)
Return the CSS class for a cell. |
void |
setDetailFormatter(DetailFormatter formatter)
|
void |
setHeight(java.lang.Integer height)
For type : "separator" , this attribute specifies
the height of the separator. |
void |
setImageHeight(java.lang.Integer imageHeight)
Height of image shown for fieldTypes image in this field. |
void |
setImageSize(java.lang.Integer imageSize)
Size of images shown for fieldTypes image in this field. |
void |
setImageURLPrefix(java.lang.String imageURLPrefix)
If this field has type set to "image"
and the URL for the image displayed is not absolute, the path of the URL will be relative
to this string |
void |
setImageWidth(java.lang.Integer imageWidth)
Width of images shown for fieldTypes image in this field. |
void |
setName(java.lang.String name)
|
void |
setShowIfCondition(DetailViewerFieldIfFunction showIf)
If specified on a field, this method is evaluated at draw time to determine whether or not to show this particular field. |
void |
setTitle(java.lang.String title)
The title of the field as displayed on the left-hand side. |
void |
setType(java.lang.String type)
Specifies the type of this DetailViewerField. |
void |
setValue(java.lang.String value)
When a field specifies its type to be "header", the value of
this attribute specifies the header text. |
void |
setValueMap(java.util.Map valueMap)
A property list (or an expression that evaluates to a property list) specifying a mapping of internal values to display values for the field (row). |
Methods inherited from class com.smartgwt.client.core.JsObject |
---|
isCreated, setJsObj |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DetailViewerField()
public DetailViewerField(com.google.gwt.core.client.JavaScriptObject jsObj)
public DetailViewerField(java.lang.String name)
public DetailViewerField(java.lang.String name, java.lang.String title)
Method Detail |
---|
public static DetailViewerField getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public void setImageSize(java.lang.Integer imageSize)
If set to a String, assumed to be a property on each record that specifies the image
height. For example, if field.imageSize
is "logoSize",
record.logoSize
will control the size of the image.
imageSize
- imageSize Default value is nullpublic java.lang.Integer getImageSize()
If set to a String, assumed to be a property on each record that specifies the image
height. For example, if field.imageSize
is "logoSize",
record.logoSize
will control the size of the image.
public void setImageWidth(java.lang.Integer imageWidth)
If set to a String, assumed to be a property on each record that specifies the image
width. For example, if field.imageWidth
is "logoWidth",
record.logoWidth
will control the width of the image.
imageWidth
- imageWidth Default value is nullpublic java.lang.Integer getImageWidth()
If set to a String, assumed to be a property on each record that specifies the image
width. For example, if field.imageWidth
is "logoWidth",
record.logoWidth
will control the width of the image.
public void setImageHeight(java.lang.Integer imageHeight)
If set to a String, assumed to be a property on each record that specifies the image
height. For example, if field.imageHeight
is "logoHeight",
record.logoHeight
will control the height of the image.
imageHeight
- imageHeight Default value is nullpublic java.lang.Integer getImageHeight()
If set to a String, assumed to be a property on each record that specifies the image
height. For example, if field.imageHeight
is "logoHeight",
record.logoHeight
will control the height of the image.
public void setImageURLPrefix(java.lang.String imageURLPrefix)
"image"
and the URL for the image displayed is not absolute, the path of the URL will be relative
to this stringNote : This is an advanced setting
imageURLPrefix
- imageURLPrefix Default value is nullpublic java.lang.String getImageURLPrefix()
"image"
and the URL for the image displayed is not absolute, the path of the URL will be relative
to this string
public void setType(java.lang.String type)
null
)
the field shows a field title on the left and the field value on the right. There are
two special values for this attribute:
value
attribute with the style specifed by headerStyle
. You can use this
field type as a titled separator.
separatorStyle
. The height of the separator field can be controlled
via height
.
imageSize
,
imageWidth
, imageHeight
type
- type Default value is nullpublic java.lang.String getType()
null
)
the field shows a field title on the left and the field value on the right. There are
two special values for this attribute:
value
attribute with the style specifed by headerStyle
. You can use this
field type as a titled separator.
separatorStyle
. The height of the separator field can be controlled
via height
.
imageSize
,
imageWidth
, imageHeight
public void setTitle(java.lang.String title)
fieldIdProperty
on this field. So, by default, the title of a field
is the value of its "name" property.
title
- title Default value is nullpublic java.lang.String getTitle()
fieldIdProperty
on this field. So, by default, the title of a field
is the value of its "name" property.
public void setValue(java.lang.String value)
type
to be "header", the value of
this attribute specifies the header text.
value
- value Default value is "undefined"public java.lang.String getValue()
type
to be "header", the value of
this attribute specifies the header text.
public void setHeight(java.lang.Integer height)
type
: "separator"
, this attribute specifies
the height of the separator.
height
- height Default value is nullpublic java.lang.Integer getHeight()
type
: "separator"
, this attribute specifies
the height of the separator.
public void setCellStyle(java.lang.String cellStyle)
cellStyle
- the cellStylepublic java.lang.String getCellStyle()
public void setName(java.lang.String name)
public java.lang.String getName()
public void setValueMap(java.util.Map valueMap)
valueMap
- valueMap Default value is nullpublic void setShowIfCondition(DetailViewerFieldIfFunction showIf)
This method can be specified either as a function or a string that will be auto-converted to a function.
public void setDetailFormatter(DetailFormatter formatter)
public void setCellStyleHandler(CellStyleHandler handler)
Cell Styles customizable by:
cellStyle
DetailViewer.getCellStyle()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |