|
|||||||||
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(JavaScriptObject jsObj)
|
|
DetailViewerField(java.lang.String name)
|
|
DetailViewerField(java.lang.String name,
java.lang.String title)
|
Method Summary | |
---|---|
java.lang.Boolean |
getCanExport()
Dictates whether the data in this field be exported. |
java.lang.String |
getCellStyle()
If specified, cells in this field will be rendered using this css className rather than cellStyle |
java.lang.String |
getDataPath()
dataPath property allows this field to display detail from nested data structures |
DateDisplayFormat |
getDateFormatter()
Display format to use for date type values within this field. |
java.lang.Boolean |
getEscapeHTML()
By default HTML values in DetailViewer cells will be interpreted by the browser. |
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()
Name property used to identify the field, and determines which attribute from records will be displayed in this field. |
static DetailViewerField |
getOrCreateRef(JavaScriptObject jsObj)
|
java.lang.String |
getPrintCellStyle()
If specified, when generating print HTML for this detailViewer, cells in this field will be rendered using this css className rather than printCellStyle |
java.lang.Boolean |
getShowFileInline()
For a field of type:"imageFile", indicates whether to stream the image and display it inline or to display the View and Download icons. |
TimeDisplayFormat |
getTimeFormatter()
Time-format to apply to date type values within this field. |
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 |
setCanExport(java.lang.Boolean canExport)
Dictates whether the data in this field be exported. |
void |
setCellStyle(java.lang.String cellStyle)
If specified, cells in this field will be rendered using this css className rather than cellStyle |
void |
setCellStyleHandler(CellStyleHandler handler)
Return the CSS class for a cell. |
void |
setDataPath(java.lang.String dataPath)
dataPath property allows this field to display detail from nested data structures |
void |
setDateFormatter(DateDisplayFormat dateFormatter)
Display format to use for date type values within this field. |
void |
setDetailFormatter(DetailFormatter formatter)
|
void |
setEscapeHTML(java.lang.Boolean escapeHTML)
By default HTML values in DetailViewer cells will be interpreted by the browser. |
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)
Name property used to identify the field, and determines which attribute from records will be displayed in this field. |
void |
setPrintCellStyle(java.lang.String printCellStyle)
If specified, when generating print HTML for this detailViewer, cells in this field will be rendered using this css className rather than printCellStyle |
void |
setShowFileInline(java.lang.Boolean showFileInline)
For a field of type:"imageFile", indicates whether to stream the image and display it inline or to display the View and Download icons. |
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 |
setTimeFormatter(TimeDisplayFormat timeFormatter)
Time-format to apply to date type values within this 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(JavaScriptObject jsObj)
public DetailViewerField(java.lang.String name)
public DetailViewerField(java.lang.String name, java.lang.String title)
Method Detail |
---|
public static DetailViewerField getOrCreateRef(JavaScriptObject jsObj)
public void setCanExport(java.lang.Boolean canExport)
dataSourceField
is explicitly set to
canExport: false.
canExport
- canExport Default value is nullpublic java.lang.Boolean getCanExport()
dataSourceField
is explicitly set to
canExport: false.
public void setCellStyle(java.lang.String cellStyle)
cellStyle
cellStyle
- cellStyle Default value is nullpublic java.lang.String getCellStyle()
cellStyle
DetailViewer.getCellStyle
, and should return a css class
name.public void setDataPath(java.lang.String dataPath)
Note : This is an advanced setting
dataPath
- dataPath Default value is nullpublic java.lang.String getDataPath()
public void setDateFormatter(DateDisplayFormat dateFormatter)
The timeFormatter
may also be used to format
underlying Date values as times (ommitting the date part entirely). If both dateFormatter
and
timeFormatter
are specified on a field, for fields specified as type "time"
the timeFormatter
will be used,
otherwise the dateFormatter
If field.dateFormatter
and field.timeFormatter
is
unspecified, date display format may be defined at the component level via dateFormatter
, or for fields of type
"datetime"
datetimeFormatter
.
Otherwise the default is to use the system-wide default normal date format, configured via Date.setNormalDisplayFormat.
Specify any valid DateDisplayFormat
to change the format used by this item.
dateFormatter
- dateFormatter Default value is nullListGrid.setDateFormatter(com.smartgwt.client.types.DateDisplayFormat)
,
ListGrid.setDatetimeFormatter(com.smartgwt.client.types.DateDisplayFormat)
,
ListGridField.setTimeFormatter(com.smartgwt.client.types.TimeDisplayFormat)
public DateDisplayFormat getDateFormatter()
The timeFormatter
may also be used to format
underlying Date values as times (ommitting the date part entirely). If both dateFormatter
and
timeFormatter
are specified on a field, for fields specified as type "time"
the timeFormatter
will be used,
otherwise the dateFormatter
If field.dateFormatter
and field.timeFormatter
is
unspecified, date display format may be defined at the component level via dateFormatter
, or for fields of type
"datetime"
datetimeFormatter
.
Otherwise the default is to use the system-wide default normal date format, configured via Date.setNormalDisplayFormat.
Specify any valid DateDisplayFormat
to change the format used by this item.
ListGrid.getDateFormatter()
,
ListGrid.getDatetimeFormatter()
,
ListGridField.getTimeFormatter()
public void setEscapeHTML(java.lang.Boolean escapeHTML)
"<b>AAA</b>"
) is
displayed to the user rather than the interpreted HTML (for example "AAA"
)
escapeHTML
- escapeHTML Default value is nullpublic java.lang.Boolean getEscapeHTML()
"<b>AAA</b>"
) is
displayed to the user rather than the interpreted HTML (for example "AAA"
)
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 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 nullsetImageSize(java.lang.Integer)
,
setImageWidth(java.lang.Integer)
,
ImageColumns overview and related methods
public 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.
getImageSize()
,
getImageWidth()
,
ImageColumns overview and related methods
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 nullsetImageWidth(java.lang.Integer)
,
setImageHeight(java.lang.Integer)
,
ImageColumns overview and related methods
public 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.
getImageWidth()
,
getImageHeight()
,
ImageColumns overview and related methods
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 nullImageColumns overview and related methods
public 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
ImageColumns overview and related methods
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 nullsetImageSize(java.lang.Integer)
,
setImageHeight(java.lang.Integer)
,
ImageColumns overview and related methods
public 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.
getImageSize()
,
getImageHeight()
,
ImageColumns overview and related methods
public void setName(java.lang.String name)
name
- name Default value is nullpublic java.lang.String getName()
public void setPrintCellStyle(java.lang.String printCellStyle)
printCellStyle
printCellStyle
- printCellStyle Default value is nullpublic java.lang.String getPrintCellStyle()
printCellStyle
public void setShowFileInline(java.lang.Boolean showFileInline)
showFileInline
- showFileInline Default value is nullpublic java.lang.Boolean getShowFileInline()
public void setTimeFormatter(TimeDisplayFormat timeFormatter)
"time"
though if no explicit dateFormatter
is specified it will be respected for other fields as well. If unspecified, a timeFormatter may be
defined at the component level
and will be
respected by fields of type "time"
.
Note : This is an advanced setting
timeFormatter
- timeFormatter Default value is nullAppearance overview and related methods
public TimeDisplayFormat getTimeFormatter()
"time"
though if no explicit dateFormatter
is specified it will be respected for other fields as well. If unspecified, a timeFormatter may be
defined at the component level
and will be
respected by fields of type "time"
.
Appearance overview and related methods
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 nullDetailViewer.setFieldIdProperty(java.lang.String)
public java.lang.String getTitle()
fieldIdProperty
on
this field. So, by default, the title of a field is the value of its "name" property.
DetailViewer.getFieldIdProperty()
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 specified 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 specified 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 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 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.
showIf
- the showIf criteriapublic 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 |