com.smartgwt.client.widgets.viewer
Class DetailViewerField

java.lang.Object
  com.smartgwt.client.core.JsObject
      com.smartgwt.client.core.DataClass
          com.smartgwt.client.widgets.viewer.DetailViewerField

public class DetailViewerField
extends DataClass

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.DataClass

doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, getJsObj, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute

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

DetailViewerField

public DetailViewerField()

DetailViewerField

public DetailViewerField(JavaScriptObject jsObj)

DetailViewerField

public DetailViewerField(java.lang.String name)

DetailViewerField

public DetailViewerField(java.lang.String name,
                         java.lang.String title)

Method Detail

getOrCreateRef

public static DetailViewerField getOrCreateRef(JavaScriptObject jsObj)

setCanExport

public void setCanExport(java.lang.Boolean canExport)

Dictates whether the data in this field be exported. Explicitly set this to false to prevent exporting. Has no effect if the underlying dataSourceField is explicitly set to canExport: false.

Parameters:

canExport - canExport Default value is null

getCanExport

public java.lang.Boolean getCanExport()

Dictates whether the data in this field be exported. Explicitly set this to false to prevent exporting. Has no effect if the underlying dataSourceField is explicitly set to canExport: false.

Returns:

Boolean

setCellStyle

public void setCellStyle(java.lang.String cellStyle)

If specified, cells in this field will be rendered using this css className rather than cellStyle

Parameters:

cellStyle - cellStyle Default value is null

getCellStyle

public java.lang.String getCellStyle()

If specified, cells in this field will be rendered using this css className rather than cellStyle

Returns:

Optional method to return the CSS class for cells in this field. If specified, this method will be called from DetailViewer.getCellStyle, and should return a css class name.

setDataPath

public void setDataPath(java.lang.String dataPath)

dataPath property allows this field to display detail from nested data structures

Note : This is an advanced setting

Parameters:

dataPath - dataPath Default value is null

getDataPath

public java.lang.String getDataPath()

dataPath property allows this field to display detail from nested data structures

Returns:

String

setDateFormatter

public void setDateFormatter(DateDisplayFormat dateFormatter)

Display format to use for date type values within this field.

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.

Parameters:

dateFormatter - dateFormatter Default value is null

See Also:

ListGrid.setDateFormatter(com.smartgwt.client.types.DateDisplayFormat), ListGrid.setDatetimeFormatter(com.smartgwt.client.types.DateDisplayFormat), ListGridField.setTimeFormatter(com.smartgwt.client.types.TimeDisplayFormat)

getDateFormatter

public DateDisplayFormat getDateFormatter()

Display format to use for date type values within this field.

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.

Returns:

DateDisplayFormat

See Also:

ListGrid.getDateFormatter(), ListGrid.getDatetimeFormatter(), ListGridField.getTimeFormatter()

setEscapeHTML

public void setEscapeHTML(java.lang.Boolean escapeHTML)

By default HTML values in DetailViewer cells will be interpreted by the browser. Setting this flag to true will causes HTML characters to be escaped, meaning the raw value of the field (for example "<b>AAA</b>") is displayed to the user rather than the interpreted HTML (for example "AAA")

Parameters:

escapeHTML - escapeHTML Default value is null

getEscapeHTML

public java.lang.Boolean getEscapeHTML()

By default HTML values in DetailViewer cells will be interpreted by the browser. Setting this flag to true will causes HTML characters to be escaped, meaning the raw value of the field (for example "<b>AAA</b>") is displayed to the user rather than the interpreted HTML (for example "AAA")

Returns:

Boolean

setHeight

public void setHeight(java.lang.Integer height)

For type: "separator", this attribute specifies the height of the separator.

Parameters:

height - height Default value is null

getHeight

public java.lang.Integer getHeight()

For type: "separator", this attribute specifies the height of the separator.

Returns:

Integer

setImageHeight

public void setImageHeight(java.lang.Integer imageHeight)

Height of image shown for fieldTypes image in this field.

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.

Parameters:

imageHeight - imageHeight Default value is null

See Also:

setImageSize(java.lang.Integer), setImageWidth(java.lang.Integer), ImageColumns overview and related methods

getImageHeight

public java.lang.Integer getImageHeight()

Height of image shown for fieldTypes image in this field.

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.

Returns:

Integer

See Also:

getImageSize(), getImageWidth(), ImageColumns overview and related methods

setImageSize

public void setImageSize(java.lang.Integer imageSize)

Size of images shown for fieldTypes image in this field.

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.

Parameters:

imageSize - imageSize Default value is null

See Also:

setImageWidth(java.lang.Integer), setImageHeight(java.lang.Integer), ImageColumns overview and related methods

getImageSize

public java.lang.Integer getImageSize()

Size of images shown for fieldTypes image in this field.

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.

Returns:

Integer

See Also:

getImageWidth(), getImageHeight(), ImageColumns overview and related methods

setImageURLPrefix

public 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

Note : This is an advanced setting

Parameters:

imageURLPrefix - imageURLPrefix Default value is null

See Also:

ImageColumns overview and related methods

getImageURLPrefix

public 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

Returns:

String

See Also:

ImageColumns overview and related methods

setImageWidth

public void setImageWidth(java.lang.Integer imageWidth)

Width of images shown for fieldTypes image in this field.

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.

Parameters:

imageWidth - imageWidth Default value is null

See Also:

setImageSize(java.lang.Integer), setImageHeight(java.lang.Integer), ImageColumns overview and related methods

getImageWidth

public java.lang.Integer getImageWidth()

Width of images shown for fieldTypes image in this field.

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.

Returns:

Integer

See Also:

getImageSize(), getImageHeight(), ImageColumns overview and related methods

setName

public 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.

Parameters:

name - name Default value is null

getName

public java.lang.String getName()

Name property used to identify the field, and determines which attribute from records will be displayed in this field.

Returns:

String

setPrintCellStyle

public 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

Parameters:

printCellStyle - printCellStyle Default value is null

getPrintCellStyle

public 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

Returns:

String

setShowFileInline

public 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.

Parameters:

showFileInline - showFileInline Default value is null

getShowFileInline

public 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.

Returns:

Boolean

setTimeFormatter

public void setTimeFormatter(TimeDisplayFormat timeFormatter)

Time-format to apply to date type values within this field. If specified, any dates displayed in this field will be formatted as times using the appropriate format. This is most commonly only applied to fields specified as type "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

Parameters:

timeFormatter - timeFormatter Default value is null

See Also:

Appearance overview and related methods

getTimeFormatter

public TimeDisplayFormat getTimeFormatter()

Time-format to apply to date type values within this field. If specified, any dates displayed in this field will be formatted as times using the appropriate format. This is most commonly only applied to fields specified as type "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".

Returns:

TimeDisplayFormat

See Also:

Appearance overview and related methods

setTitle

public void setTitle(java.lang.String title)

The title of the field as displayed on the left-hand side. If left unspecified, the title of the field is derived by looking up the value of fieldIdProperty on this field. So, by default, the title of a field is the value of its "name" property.

Parameters:

title - title Default value is null

See Also:

DetailViewer.setFieldIdProperty(java.lang.String)

getTitle

public java.lang.String getTitle()

The title of the field as displayed on the left-hand side. If left unspecified, the title of the field is derived by looking up the value of fieldIdProperty on this field. So, by default, the title of a field is the value of its "name" property.

Returns:

String

See Also:

DetailViewer.getFieldIdProperty()

setType

public void setType(java.lang.String type)

Specifies the type of this DetailViewerField. By default (value is 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:

• "header" - If you specify type "header", the field spans both the field name and field value columns and contains text defined in the value attribute with the style specified by headerStyle. You can use this field type as a titled separator.
• "separator" - If you specify type "separator", the field spans both the field name and the field value columns with no text, and is styled using the style specified via separatorStyle. The height of the separator field can be controlled via height.
• "image" For viewing, a thumbnail image is rendered in the field. The URL of the image is the value of the field, and should be absolute. The size of the image is controlled by imageSize, imageWidth, imageHeight

Parameters:

type - type Default value is null

getType

public java.lang.String getType()

Specifies the type of this DetailViewerField. By default (value is 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:

• "header" - If you specify type "header", the field spans both the field name and field value columns and contains text defined in the value attribute with the style specified by headerStyle. You can use this field type as a titled separator.
• "separator" - If you specify type "separator", the field spans both the field name and the field value columns with no text, and is styled using the style specified via separatorStyle. The height of the separator field can be controlled via height.
• "image" For viewing, a thumbnail image is rendered in the field. The URL of the image is the value of the field, and should be absolute. The size of the image is controlled by imageSize, imageWidth, imageHeight

Returns:

String

setValue

public void setValue(java.lang.String value)

When a field specifies its type to be "header", the value of this attribute specifies the header text.

Parameters:

value - value Default value is "undefined"

getValue

public java.lang.String getValue()

When a field specifies its type to be "header", the value of this attribute specifies the header text.

Returns:

String

setValueMap

public 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).

Parameters:

valueMap - valueMap Default value is null

setShowIfCondition

public 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.

This method can be specified either as a function or a string that will be auto-converted to a function.

Parameters:

showIf - the showIf criteria

setDetailFormatter

public void setDetailFormatter(DetailFormatter formatter)

setCellStyleHandler

public void setCellStyleHandler(CellStyleHandler handler)

Return the CSS class for a cell. Not implemented by default. The state of the record is indicated by adding a suffix to the base style. There are three independant boolean states, which are combined in the order given:

1. "Selected" : whether cell is selected; enable by passing a Selection object as "selection"
2. "Over" : mouse is over this cell; enable with showRollovers
3. "Down" : mouse button is down over this cell

For example, with a baseStyle of "myCell", a cell which is selected, which the mouse is over, will get a styleName of myCellSelectedOver.

Cell Styles customizable by:

• implementing this function
• setting cellStyle
• overriding DetailViewer.getCellStyle()