public class DetailViewerField extends DataClass
DetailViewer.factoryCreated, factoryProperties, readOnly| Constructor and Description |
|---|
DetailViewerField() |
DetailViewerField(com.google.gwt.core.client.JavaScriptObject jsObj) |
DetailViewerField(java.lang.String name) |
DetailViewerField(java.lang.String name,
java.lang.String title) |
| Modifier and Type | Method and Description |
|---|---|
java.lang.Boolean |
getCanExport()
Dictates whether the data in this field be exported.
|
java.lang.Boolean |
getCanHilite()
Determines whether this field can be hilited.
|
java.lang.String |
getCellStyle()
If specified, cells in this field will be rendered using this css className rather than
DetailViewer.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.Integer |
getDecimalPad()
Applies only to fields of type "float" and enforces a minimum number of digits shown after the decimal point.
|
java.lang.Integer |
getDecimalPrecision()
Applies only to fields of type "float" and affects how many significant digits are shown.
|
java.lang.String |
getDisplayField()
If
displayField is defined for the field then the DetailViewer will display the displayField
attribute of records instead of the attribute given by the name of the field. |
java.lang.String |
getEmptyCellValue()
The value to display for a cell whose value is null or the empty string after applying formatCellValue and valueMap (if
any).
|
java.lang.Boolean |
getEscapeHTML()
By default HTML values in DetailViewer cells will be interpreted by the browser.
|
java.lang.String |
getExportFormat()
FormatString used during exports for numeric or date formatting. |
java.lang.Boolean |
getExportRawValues()
Dictates whether the data in this field should be exported raw by
exportClientData(). |
java.lang.String |
getFormat()
FormatString for numeric or date formatting. |
java.lang.Integer |
getHeight()
For
type: "separator", this attribute
specifies the height of the separator. |
java.lang.Integer |
getHiliteIconHeight()
Height for hilite icons for this field.
|
java.lang.Integer |
getHiliteIconLeftPadding()
How much padding should there be on the left of
hilite icons for this field? Overrides DetailViewer.hiliteIconLeftPadding |
HiliteIconPosition |
getHiliteIconPosition()
When
DetailViewer.hiliteIcons are present, where
the hilite icon will be placed relative to the field value. |
java.lang.Integer |
getHiliteIconRightPadding()
How much padding should there be on the right of
hilite icons for this field? Overrides DetailViewer.hiliteIconRightPadding |
java.lang.Integer |
getHiliteIconSize()
Default width and height of
hilite icons in this
field. |
java.lang.Integer |
getHiliteIconWidth()
Width for hilite icons for this field.
|
java.lang.Integer |
getImageHeight()
Height of image shown for fieldTypes image in this field.
|
java.lang.String |
getImageHeightAsString()
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 |
getImageSizeAsString()
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 |
getImageWidthAsString()
Width of images shown for fieldTypes image in this field.
|
java.lang.String |
getIncludeFrom()
Indicates this field's values come from another, related DataSource.
|
java.lang.String |
getLinkText()
The HTML to display for values of this field if the field type is set to "link".
|
java.lang.String |
getLinkTextProperty()
Name of the property in a DetailViewerRecord that holds the HTML to display for values of this field if the field type
is set to "link".
|
java.lang.String |
getLinkURLPrefix()
If this field has type set to
"link", setting this property will apply a standard prefix to the link URL
when displaying values of this field. |
java.lang.String |
getLinkURLSuffix()
If this field has type set to
"link", setting this property will apply a standard suffix to the link URL
when displaying values of 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(com.google.gwt.core.client.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
DetailViewer.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.
|
java.lang.String |
getTarget()
By default, clicking a link rendered by this item opens it in a new browser window.
|
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 |
setCanHilite(java.lang.Boolean canHilite)
Determines whether this field can be hilited.
|
void |
setCellStyle(java.lang.String cellStyle)
If specified, cells in this field will be rendered using this css className rather than
DetailViewer.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 |
setDecimalPad(java.lang.Integer decimalPad)
Applies only to fields of type "float" and enforces a minimum number of digits shown after the decimal point.
|
void |
setDecimalPrecision(java.lang.Integer decimalPrecision)
Applies only to fields of type "float" and affects how many significant digits are shown.
|
void |
setDetailFormatter(DetailFormatter formatter) |
void |
setDisplayField(java.lang.String displayField)
If
displayField is defined for the field then the DetailViewer will display the displayField
attribute of records instead of the attribute given by the name of the field. |
void |
setEmptyCellValue(java.lang.String emptyCellValue)
The value to display for a cell whose value is null or the empty string after applying formatCellValue and valueMap (if
any).
|
void |
setEscapeHTML(java.lang.Boolean escapeHTML)
By default HTML values in DetailViewer cells will be interpreted by the browser.
|
void |
setExportFormat(java.lang.String exportFormat)
FormatString used during exports for numeric or date formatting. |
void |
setExportRawValues(java.lang.Boolean exportRawValues)
Dictates whether the data in this field should be exported raw by
exportClientData(). |
void |
setFormat(java.lang.String format)
FormatString for numeric or date formatting. |
void |
setHeight(java.lang.Integer height)
For
type: "separator", this attribute
specifies the height of the separator. |
void |
setHiliteIconHeight(java.lang.Integer hiliteIconHeight)
Height for hilite icons for this field.
|
void |
setHiliteIconLeftPadding(java.lang.Integer hiliteIconLeftPadding)
How much padding should there be on the left of
hilite icons for this field? Overrides DetailViewer.hiliteIconLeftPadding |
void |
setHiliteIconPosition(HiliteIconPosition hiliteIconPosition)
When
DetailViewer.hiliteIcons are present, where
the hilite icon will be placed relative to the field value. |
void |
setHiliteIconRightPadding(java.lang.Integer hiliteIconRightPadding)
How much padding should there be on the right of
hilite icons for this field? Overrides DetailViewer.hiliteIconRightPadding |
void |
setHiliteIconSize(java.lang.Integer hiliteIconSize)
Default width and height of
hilite icons in this
field. |
void |
setHiliteIconWidth(java.lang.Integer hiliteIconWidth)
Width for hilite icons for this field.
|
void |
setImageHeight(java.lang.Integer imageHeight)
Height of image shown for fieldTypes image in this field.
|
void |
setImageHeight(java.lang.String 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 |
setImageSize(java.lang.String 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 |
setImageWidth(java.lang.String imageWidth)
Width of images shown for fieldTypes image in this field.
|
void |
setIncludeFrom(java.lang.String includeFrom)
Indicates this field's values come from another, related DataSource.
|
void |
setLinkText(java.lang.String linkText)
The HTML to display for values of this field if the field type is set to "link".
|
void |
setLinkTextProperty(java.lang.String linkTextProperty)
Name of the property in a DetailViewerRecord that holds the HTML to display for values of this field if the field type
is set to "link".
|
void |
setLinkURLPrefix(java.lang.String linkURLPrefix)
If this field has type set to
"link", setting this property will apply a standard prefix to the link URL
when displaying values of this field. |
void |
setLinkURLSuffix(java.lang.String linkURLSuffix)
If this field has type set to
"link", setting this property will apply a standard suffix to the link URL
when displaying values of 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
DetailViewer.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 |
setTarget(java.lang.String target)
By default, clicking a link rendered by this item opens it in a new browser window.
|
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).
|
applyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, getReadOnly, isFactoryCreated, logConfiguration, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated, setReadOnlypublic 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)
public static DetailViewerField getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public void setCanExport(java.lang.Boolean canExport)
dataSourceField is explicitly set to
canExport: false.canExport - Default value is nullpublic java.lang.Boolean getCanExport()
dataSourceField is explicitly set to
canExport: false.public void setCanHilite(java.lang.Boolean canHilite)
canHilite - Default value is nullHiliting overview and related methodspublic java.lang.Boolean getCanHilite()
Hiliting overview and related methodspublic void setCellStyle(java.lang.String cellStyle)
DetailViewer.cellStylecellStyle - See CSSClassName . Default value is nullpublic java.lang.String getCellStyle()
DetailViewer.cellStyleDetailViewer.getCellStyle(), and should return a css class
name. See CSSClassNamepublic void setDataPath(java.lang.String dataPath)
Note : This is an advanced setting
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 (omitting 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 DetailViewer.dateFormatter, or for fields of type
"datetime" DetailViewer.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 - 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 (omitting 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 DetailViewer.dateFormatter, or for fields of type
"datetime" DetailViewer.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 setDecimalPad(java.lang.Integer decimalPad)
For example, a field value of 343.1, 343.104 and 343.09872677 would all be shown as 343.10 if decimalPad is 2.
The original unpadded value is always shown when the value is edited.
decimalPad - Default value is nullAppearance overview and related methodspublic java.lang.Integer getDecimalPad()
For example, a field value of 343.1, 343.104 and 343.09872677 would all be shown as 343.10 if decimalPad is 2.
The original unpadded value is always shown when the value is edited.
Appearance overview and related methodspublic void setDecimalPrecision(java.lang.Integer decimalPrecision)
For example, with decimalPrecision 3, if the field value is 343.672677, 343.673 is shown.
If the value is 125.2, 125.2 is shown -
decimalPrecision will not cause extra zeros to be added. Use DataSourceField.decimalPad for this.
A number is always shown with its original precision when edited.
decimalPrecision - Default value is nullAppearance overview and related methodspublic java.lang.Integer getDecimalPrecision()
For example, with decimalPrecision 3, if the field value is 343.672677, 343.673 is shown.
If the value is 125.2, 125.2 is shown -
decimalPrecision will not cause extra zeros to be added. Use DataSourceField.decimalPad for this.
A number is always shown with its original precision when edited.
Appearance overview and related methodspublic void setDisplayField(java.lang.String displayField)
displayField is defined for the field then the DetailViewer will display the displayField
attribute of records instead of the attribute given by the name of the field.displayField - Default value is nullpublic java.lang.String getDisplayField()
displayField is defined for the field then the DetailViewer will display the displayField
attribute of records instead of the attribute given by the name of the field.public void setEmptyCellValue(java.lang.String emptyCellValue)
This is the field-specific attribute. You may also set the emptyCellValue at the viewer level to define the emptyCellValue for all empty fields in the viewer.
emptyCellValue - See HTMLString . Default value is nullDetailViewer.setEmptyCellValue(java.lang.String),
Appearance overview and related methodspublic java.lang.String getEmptyCellValue()
This is the field-specific attribute. You may also set the emptyCellValue at the viewer level to define the emptyCellValue for all empty fields in the viewer.
HTMLStringDetailViewer.getEmptyCellValue(),
Appearance overview and related methodspublic void setEscapeHTML(java.lang.Boolean escapeHTML)
"<b>AAA</b>") is
displayed to the user rather than the interpreted HTML (for example "AAA")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 setExportFormat(java.lang.String exportFormat)
FormatString used during exports for numeric or date formatting. See DataSourceField.exportFormat.exportFormat - See FormatString . Default value is nullExportFormatting overview and related methodspublic java.lang.String getExportFormat()
FormatString used during exports for numeric or date formatting. See DataSourceField.exportFormat.FormatStringExportFormatting overview and related methodspublic void setExportRawValues(java.lang.Boolean exportRawValues)
exportClientData(). If set to true for a field, the
values in the field-formatters will not be executed for data in this field.exportRawValues - Default value is nullpublic java.lang.Boolean getExportRawValues()
exportClientData(). If set to true for a field, the
values in the field-formatters will not be executed for data in this field.public void setFormat(java.lang.String format)
FormatString for numeric or date formatting. See DataSourceField.format.format - See FormatString . Default value is nullExportFormatting overview and related methodspublic java.lang.String getFormat()
FormatString for numeric or date formatting. See DataSourceField.format.FormatStringExportFormatting overview and related methodspublic void setHeight(java.lang.Integer height)
type: "separator", this attribute
specifies the height of the separator.height - Default value is nullpublic java.lang.Integer getHeight()
type: "separator", this attribute
specifies the height of the separator.public void setHiliteIconHeight(java.lang.Integer hiliteIconHeight)
DetailViewer.hiliteIconSize, DetailViewer.hiliteIconHeight, and hiliteIconSize.hiliteIconHeight - Default value is nullHiliting overview and related methodspublic java.lang.Integer getHiliteIconHeight()
DetailViewer.hiliteIconSize, DetailViewer.hiliteIconHeight, and hiliteIconSize.Hiliting overview and related methodspublic void setHiliteIconLeftPadding(java.lang.Integer hiliteIconLeftPadding)
hilite icons for this field? Overrides DetailViewer.hiliteIconLeftPaddinghiliteIconLeftPadding - Default value is nullHiliting overview and related methodspublic java.lang.Integer getHiliteIconLeftPadding()
hilite icons for this field? Overrides DetailViewer.hiliteIconLeftPaddingHiliting overview and related methodspublic void setHiliteIconPosition(HiliteIconPosition hiliteIconPosition)
DetailViewer.hiliteIcons are present, where
the hilite icon will be placed relative to the field value. See HiliteIconPosition.
Overrides DetailViewer.hiliteIconPositionhiliteIconPosition - Default value is nullHiliting overview and related methodspublic HiliteIconPosition getHiliteIconPosition()
DetailViewer.hiliteIcons are present, where
the hilite icon will be placed relative to the field value. See HiliteIconPosition.
Overrides DetailViewer.hiliteIconPositionHiliting overview and related methodspublic void setHiliteIconRightPadding(java.lang.Integer hiliteIconRightPadding)
hilite icons for this field? Overrides DetailViewer.hiliteIconRightPaddinghiliteIconRightPadding - Default value is nullHiliting overview and related methodspublic java.lang.Integer getHiliteIconRightPadding()
hilite icons for this field? Overrides DetailViewer.hiliteIconRightPaddingHiliting overview and related methodspublic void setHiliteIconSize(java.lang.Integer hiliteIconSize)
hilite icons in this
field. Takes precedence over hiliteIconWidth, hiliteIconHeight and hiliteIconSize specified at the component level. Can
be overridden via hiliteIconWidth and
hiliteIconHeighthiliteIconSize - Default value is nullDetailViewer.setHiliteIconSize(int),
setHiliteIconWidth(java.lang.Integer),
setHiliteIconHeight(java.lang.Integer),
Hiliting overview and related methodspublic java.lang.Integer getHiliteIconSize()
hilite icons in this
field. Takes precedence over hiliteIconWidth, hiliteIconHeight and hiliteIconSize specified at the component level. Can
be overridden via hiliteIconWidth and
hiliteIconHeightDetailViewer.getHiliteIconSize(),
getHiliteIconWidth(),
getHiliteIconHeight(),
Hiliting overview and related methodspublic void setHiliteIconWidth(java.lang.Integer hiliteIconWidth)
DetailViewer.hiliteIconSize, DetailViewer.hiliteIconWidth, and hiliteIconSize.hiliteIconWidth - Default value is nullHiliting overview and related methodspublic java.lang.Integer getHiliteIconWidth()
DetailViewer.hiliteIconSize, DetailViewer.hiliteIconWidth, and hiliteIconSize.Hiliting overview and related methodspublic 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 - Default value is nullsetImageSize(java.lang.Integer),
setImageWidth(java.lang.Integer),
ImageColumns overview and related methodspublic 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 methodspublic void setImageHeight(java.lang.String 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 - Default value is nullsetImageSize(java.lang.Integer),
setImageWidth(java.lang.Integer),
ImageColumns overview and related methodspublic java.lang.String getImageHeightAsString()
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 methodspublic 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 - Default value is nullsetImageWidth(java.lang.Integer),
setImageHeight(java.lang.Integer),
ImageColumns overview and related methodspublic 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 methodspublic void setImageSize(java.lang.String 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 - Default value is nullsetImageWidth(java.lang.Integer),
setImageHeight(java.lang.Integer),
ImageColumns overview and related methodspublic java.lang.String getImageSizeAsString()
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 methodspublic 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 - Default value is nullImageColumns overview and related methodspublic 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 stringImageColumns overview and related methodspublic 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 - Default value is nullsetImageSize(java.lang.Integer),
setImageHeight(java.lang.Integer),
ImageColumns overview and related methodspublic 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 methodspublic void setImageWidth(java.lang.String 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 - Default value is nullsetImageSize(java.lang.Integer),
setImageHeight(java.lang.Integer),
ImageColumns overview and related methodspublic java.lang.String getImageWidthAsString()
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 methodspublic void setIncludeFrom(java.lang.String includeFrom)
field.type and field.title from the related DataSource just like fields
from the primary DataSource.includeFrom - Default value is nullpublic java.lang.String getIncludeFrom()
field.type and field.title from the related DataSource just like fields
from the primary DataSource.public void setLinkText(java.lang.String linkText)
This property sets linkText that
will be the same for all records. You can set linkText on a per-record basis via DetailViewerRecord.linkText.
linkText - Default value is nullsetType(java.lang.String),
DetailViewerRecord.setLinkText(java.lang.String),
DetailViewer.setLinkTextProperty(java.lang.String),
setLinkTextProperty(java.lang.String)public java.lang.String getLinkText()
This property sets linkText that
will be the same for all records. You can set linkText on a per-record basis via DetailViewerRecord.linkText.
getType(),
DetailViewerRecord.getLinkText(),
DetailViewer.getLinkTextProperty(),
getLinkTextProperty()public void setLinkTextProperty(java.lang.String linkTextProperty)
linkTextProperty - Default value is nullsetType(java.lang.String),
DetailViewerRecord.setLinkText(java.lang.String),
setLinkText(java.lang.String),
DetailViewer.setLinkTextProperty(java.lang.String)public java.lang.String getLinkTextProperty()
getType(),
DetailViewerRecord.getLinkText(),
getLinkText(),
DetailViewer.getLinkTextProperty()public void setLinkURLPrefix(java.lang.String linkURLPrefix)
"link", setting this property will apply a standard prefix to the link URL
when displaying values of this field.
Note : This is an advanced setting
linkURLPrefix - Default value is nullsetType(java.lang.String)public java.lang.String getLinkURLPrefix()
"link", setting this property will apply a standard prefix to the link URL
when displaying values of this field.getType()public void setLinkURLSuffix(java.lang.String linkURLSuffix)
"link", setting this property will apply a standard suffix to the link URL
when displaying values of this field.
Note : This is an advanced setting
linkURLSuffix - Default value is nullsetType(java.lang.String)public java.lang.String getLinkURLSuffix()
"link", setting this property will apply a standard suffix to the link URL
when displaying values of this field.getType()public void setName(java.lang.String name)
Must be unique within the DetailViewer as well as a valid JavaScript identifier, as specified by ECMA-262 Section 7.6 (the StringUtil.isValidID() function can be used to test whether a name is a valid JavaScript identifier).
The
attribute of the records to display in this field may also be set by displayField.
name - Default value is nullpublic java.lang.String getName()
Must be unique within the DetailViewer as well as a valid JavaScript identifier, as specified by ECMA-262 Section 7.6 (the StringUtil.isValidID() function can be used to test whether a name is a valid JavaScript identifier).
The
attribute of the records to display in this field may also be set by displayField.
public void setPrintCellStyle(java.lang.String printCellStyle)
DetailViewer.printCellStyleprintCellStyle - See CSSClassName . Default value is nullpublic java.lang.String getPrintCellStyle()
DetailViewer.printCellStyleCSSClassNamepublic void setShowFileInline(java.lang.Boolean showFileInline)
showFileInline - Default value is nullpublic java.lang.Boolean getShowFileInline()
public void setTarget(java.lang.String target)
target attribute of
the anchor tag used to render the link. target is applicable only if the field type is set to "link".target - Default value is "_blank"setType(java.lang.String)public java.lang.String getTarget()
target attribute of
the anchor tag used to render the link. target is applicable only if the field type is set to "link".getType()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 - Default value is nullAppearance overview and related methodspublic 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 methodspublic void setTitle(java.lang.String title)
DetailViewer.fieldIdProperty on this field. So, by default, the title of a field is the value of its "name" property.title - See HTMLString . Default value is nullDetailViewer.setFieldIdProperty(java.lang.String)public java.lang.String getTitle()
DetailViewer.fieldIdProperty on this field. So, by default, the title of a field is the value of its "name" property.HTMLStringDetailViewer.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 four special values for this attribute: value attribute with the style specified by DetailViewer.headerStyle. You can use this field type
as a titled separator. DetailViewer.separatorStyle. The height of the
separator field can be controlled via height.
imageSize, imageWidth, imageHeight "link" For viewing, a clickable
html link (using an HTML anchor tag: <A>) is rendered in the field. The target URL is the value of the field,
which is also the default display value. You can override the display value by setting DetailViewerRecord.linkText or linkText.
Clicking the link opens the URL in a
new window by default. To change this behavior, you can set field.target, which works identically to the
"target" attribute on an HTML anchor (<A>) tag. See target for more information.
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 four special values for this attribute: value attribute with the style specified by DetailViewer.headerStyle. You can use this field type
as a titled separator. DetailViewer.separatorStyle. The height of the
separator field can be controlled via height.
imageSize, imageWidth, imageHeight "link" For viewing, a clickable
html link (using an HTML anchor tag: <A>) is rendered in the field. The target URL is the value of the field,
which is also the default display value. You can override the display value by setting DetailViewerRecord.linkText or linkText.
Clicking the link opens the URL in a
new window by default. To change this behavior, you can set field.target, which works identically to the
"target" attribute on an HTML anchor (<A>) tag. See target for more information.
public void setValue(java.lang.String value)
type to be "header", the
value of this attribute specifies the header text.value - See HTMLString . Default value is "undefined"public java.lang.String getValue()
type to be "header", the
value of this attribute specifies the header text.HTMLStringpublic void setValueMap(java.util.Map 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()