de.bea.domingo.proxy
Class ViewColumnProxy

java.lang.Object
  de.bea.domingo.monitor.AbstractMonitorEnabled
      de.bea.domingo.proxy.BaseProxy
          de.bea.domingo.proxy.ViewColumnProxy

All Implemented Interfaces:

DBase, DViewColumn, MonitorEnabled, java.io.Serializable

public final class ViewColumnProxy
extends BaseProxy
implements DViewColumn

Represents the Domino-Class View.

Author:

Kurt Riede

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.bea.domingo.proxy.BaseProxy

BaseProxy.DocumentCollectionIterator

Field Summary

Fields inherited from class de.bea.domingo.proxy.BaseProxy

DATETIME_STRING_LENGTH, EMPTY_STRING, MAX_DATETIME_LENGTH, NUM_DATETIME_VALUES, RESOURCES

Fields inherited from interface de.bea.domingo.DViewColumn

ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT, ATTR_PARENS, ATTR_PERCENT, ATTR_PUNCTUATED, FMT_ALL, FMT_ALWAYS, FMT_CURRENCY, FMT_DATE, FMT_DATETIME, FMT_FIXED, FMT_GENERAL, FMT_H, FMT_HM, FMT_HMS, FMT_MD, FMT_NEVER, FMT_SCIENTIFIC, FMT_SOMETIMES, FMT_TIME, FMT_TODAYTIME, FMT_Y4M, FMT_YM, FMT_YMD, FONT_BOLD, FONT_ITALIC, FONT_PLAIN, FONT_STRIKEOUT, FONT_STRIKETHROUGH, FONT_UNDERLINE, SEP_COMMA, SEP_NEWLINE, SEP_NONE, SEP_SEMICOLON, SEP_SPACE

Method Summary

int	getAlignment() The alignment of data in a column.
int	getDateFmt() The format of date data in a column.
int	getFontColor() The font color of data in a column.
java.lang.String	getFontFace() The font face of data in a column.
int	getFontPointSize() The font point size of data in a column.
int	getFontStyle() The font style of data in a column.
java.lang.String	getFormula() The formula for a column that is based on a simple function or a formula.
int	getHeaderAlignment() The alignment of the header in a column.
int	getHeaderFontColor() The font color of the header in a column.
java.lang.String	getHeaderFontFace() The font face of the header in a column.
int	getHeaderFontPointSize() The font point size of the header in a column.
int	getHeaderFontStyle() The font style of the header in a column.
(package private) static ViewColumnProxy	getInstance(NotesProxyFactory theFactory, DView view, lotus.domino.ViewColumn viewColumn, DNotesMonitor monitor) Returns a view object.
java.lang.String	getItemName() The programmatic name of a column, which is usually the field (item) name for a column based on a field.
int	getListSep() List (multi-value) separator for values in a column.
int	getNumberAttrib() Attributes for numeric values in a column.
int	getNumberDigits() Number of decimal places for numeric values in a column.
int	getNumberFormat() Format for numeric values in a column.
int	getPosition() The position of a column in its view.
java.lang.String	getResortToViewName() The name of the target view for a user-sorted column that allows the user to change to another view.
int	getSecondaryResortColumnIndex() The index of the secondary sorting column of a user-sorted column that allows a secondary sorting column.
int	getTimeDateFmt() The format of time-date data in a column.
int	getTimeFmt() The format of time data in a column.
int	getTimeZoneFmt() The format of the zone in a time-date column value.
java.lang.String	getTitle() The title of a column or an empty string if the column does not have a title.
int	getWidth() The width of a column.
boolean	isAccentSensitiveSort() Indicates whether an auto-sorted column is sorted with regard to accent.
boolean	isCaseSensitiveSort() Indicates whether an auto-sorted column is sorted with regard to case.
boolean	isCategory() Indicates whether a column is categorized.
boolean	isField() Indicates whether a column value is based on a field value.
boolean	isFontBold() Indicates whether the font style for a column includes bold.
boolean	isFontItalic() Indicates whether the font style for a column includes italic.
boolean	isFontStrikethrough() Indicates whether the font style for a column includes strikethrough.
boolean	isFontUnderline() Indicates whether the font style for a column includes underline.
boolean	isFormula() Indicates whether a column value is based on a simple function or a formula.
boolean	isHeaderFontBold() Indicates whether the header font style for a column includes bold.
boolean	isHeaderFontItalic() Indicates whether the header font style for a column includes italic.
boolean	isHeaderFontStrikethrough() Indicates whether the header font style for a column includes strikethrough.
boolean	isHeaderFontUnderline() Indicates whether the header font style for a column includes underline.
boolean	isHidden() Indicates whether a column is hidden.
boolean	isHideDetail() Indicates whether the details for total columns are hidden.
boolean	isIcon() Indicates whether column values are displayed as icons.
boolean	isNumberAttribParens() Indicates whether the number attributes for a column include parentheses for negative numbers.
boolean	isNumberAttribPercent() Indicates whether the number attributes for a column include displaying the number as a percentage.
boolean	isNumberAttribPunctuated() Indicates whether the number attributes for a column include punctuation at thousandths.
boolean	isResize() Indicates whether a column is resizable.
boolean	isResortAscending() Indicates whether a column is a user-sorted column that can be sorted in ascending order.
boolean	isResortDescending() Indicates whether a column is a user-sorted column that can be sorted in descending order.
boolean	isResortToView() Indicates whether a column is a user-sorted column that allows the user to change to another view.
boolean	isResponse() Indicates whether a column contains only response documents.
boolean	isSecondaryResort() Indicates whether an ascending or descending user-sorted column has a secondary sorting column.
boolean	isSecondaryResortDescending() Indicates whether a secondary sorting column for a user-sorted column is sorted in descending order.
boolean	isShowTwistie() Indicates whether an expandable column displays a twistie.
boolean	isSortDescending() Indicates whether an auto-sorted column is sorted in descending order.
boolean	isSorted() Indicates whether a column is an auto-sorted column.
void	setAccentSensitiveSort(boolean arg1) Indicates whether an auto-sorted column is sorted with regard to accent.
void	setAlignment(int alignment) The alignment of data in a column.
void	setCaseSensitiveSort(boolean arg1) Indicates whether an auto-sorted column is sorted with regard to case.
void	setDateFmt(int arg1) The format of date data in a column.
void	setFontBold(boolean arg1) Indicates whether the font style for a column includes bold.
void	setFontColor(int arg1) The font color of data in a column.
void	setFontFace(java.lang.String arg1) The font face of data in a column.
void	setFontItalic(boolean arg1) Indicates whether the font style for a column includes italic.
void	setFontPointSize(int arg1) The font point size of data in a column.
void	setFontStrikethrough(boolean arg1) Indicates whether the font style for a column includes strikethrough.
void	setFontStyle(int arg1) The font style of data in a column.
void	setFontUnderline(boolean arg1) Indicates whether the font style for a column includes underline.
void	setFormula(java.lang.String arg1) The formula for a column that is based on a simple function or a formula.
void	setHeaderAlignment(int arg1) The alignment of the header in a column.
void	setHeaderFontBold(boolean arg1) Indicates whether the header font style for a column includes bold.
void	setHeaderFontColor(int arg1) The font color of the header in a column.
void	setHeaderFontFace(java.lang.String arg1) The font face of the header in a column.
void	setHeaderFontItalic(boolean arg1) Indicates whether the header font style for a column includes italic.
void	setHeaderFontPointSize(int arg1) The font point size of the header in a column.
void	setHeaderFontStrikethrough(boolean arg1) Indicates whether the header font style for a column includes strikethrough.
void	setHeaderFontStyle(int arg1) The font style of the header in a column.
void	setHeaderFontUnderline(boolean arg1) Indicates whether the header font style for a column includes underline.
void	setHidden(boolean flag) Indicates whether a column is hidden.
void	setHideDetail(boolean arg1) Indicates whether the details for total columns are hidden.
void	setListSep(int arg1) List (multi-value) separator for values in a column.
void	setNumberAttrib(int arg1) Attributes for numeric values in a column.
void	setNumberAttribParens(boolean arg1) Indicates whether the number attributes for a column include parentheses for negative numbers.
void	setNumberAttribPercent(boolean arg1) Indicates whether the number attributes for a column include displaying the number as a percentage.
void	setNumberAttribPunctuated(boolean arg1) Indicates whether the number attributes for a column include punctuation at thousandths.
void	setNumberDigits(int arg1) Number of decimal places for numeric values in a column.
void	setNumberFormat(int arg1) Format for numeric values in a column.
void	setResize(boolean arg1) Indicates whether a column is resizable.
void	setResortAscending(boolean arg1) Indicates whether a column is a user-sorted column that can be sorted in ascending order.
void	setResortDescending(boolean arg1) Indicates whether a column is a user-sorted column that can be sorted in descending order.
void	setResortToView(boolean arg1) Indicates whether a column is a user-sorted column that allows the user to change to another view.
void	setResortToViewName(java.lang.String arg1) The name of the target view for a user-sorted column that allows the user to change to another view.
void	setSecondaryResort(boolean arg1) Indicates whether an ascending or descending user-sorted column has a secondary sorting column.
void	setSecondaryResortColumnIndex(int arg1) The index of the secondary sorting column of a user-sorted column that allows a secondary sorting column.
void	setSecondaryResortDescending(boolean arg1) Indicates whether a secondary sorting column for a user-sorted column is sorted in descending order.
void	setShowTwistie(boolean arg1) Indicates whether an expandable column displays a twistie.
void	setSortDescending(boolean arg1) Indicates whether an auto-sorted column is sorted in descending order.
void	setSorted(boolean arg1) Indicates whether a column is an auto-sorted column.
void	setTimeDateFmt(int arg1) The format of time-date data in a column.
void	setTimeFmt(int arg1) The format of time data in a column.
void	setTimeZoneFmt(int arg1) The format of the zone in a time-date column value.
void	setTitle(java.lang.String title) The title of a column or an empty string if the column does not have a title.
void	setWidth(int arg1) The width of a column.
java.lang.String	toString() Returns a short description of an instance.

Methods inherited from class de.bea.domingo.proxy.BaseProxy

checkSession, clearNotesObject, convertCalendarsToNotesDateTime, convertListToVector, convertNotesDateTimesToCalendar, convertVectorToList, createCalendar, createDateRange, createDateTime, decrementDateTimeCounter, finalize, getCountDateTime, getDSession, getFactory, getNotesObject, getParent, incrementDateTimeCounter, newException, newException, newException, newRuntimeException, newRuntimeException, newRuntimeException, recycleDateTimeList, refereceHashCode, toStringGeneric, toStringIntern

Methods inherited from class de.bea.domingo.monitor.AbstractMonitorEnabled

getMonitor, setMonitor

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.bea.domingo.DBase

equals, hashCode

Method Detail

getInstance

static ViewColumnProxy getInstance(NotesProxyFactory theFactory,
                                   DView view,
                                   lotus.domino.ViewColumn viewColumn,
                                   DNotesMonitor monitor)

Returns a view object.

Parameters:

theFactory - the controlling factory

view - the parent view

viewColumn - the notes view object

monitor - the monitor

Returns:

a view object

getAlignment

public int getAlignment()

The alignment of data in a column.

Specified by:

getAlignment in interface DViewColumn

Returns:

alignment of a column

See Also:

DViewColumn.getAlignment()

getDateFmt

public int getDateFmt()

The format of date data in a column.

Specified by:

getDateFmt in interface DViewColumn

Returns:

DViewColumn.FMT_MD (month and day), DViewColumn.FMT_YM (year and month), DViewColumn.FMT_Y4M (4-digit year and month) or DViewColumn.FMT_YMD (year, month, and day)

See Also:

DViewColumn.getDateFmt()

getFontColor

public int getFontColor()

The font color of data in a column.

Specified by:

getFontColor in interface DViewColumn

Returns:

A Domino color index in the range 0-240

The first 16 color indices are:

DRichTextStyle.COLOR_BLACK, DRichTextStyle.COLOR_BLUE, DRichTextStyle.COLOR_CYAN, DRichTextStyle.COLOR_DARK_BLUE, DRichTextStyle.COLOR_DARK_CYAN, DRichTextStyle.COLOR_DARK_GREEN, DRichTextStyle.COLOR_DARK_MAGENTA, DRichTextStyle.COLOR_DARK_RED, DRichTextStyle.COLOR_DARK_YELLOW, DRichTextStyle.COLOR_GRAY, DRichTextStyle.COLOR_GREEN, DRichTextStyle.COLOR_LIGHT_GRAY, DRichTextStyle.COLOR_MAGENTA, DRichTextStyle.COLOR_RED, DRichTextStyle.COLOR_WHITE, DRichTextStyle.COLOR_YELLOW

See Also:

DViewColumn.getFontColor()

getFontFace

public java.lang.String getFontFace()

The font face of data in a column.

Typical font faces include Ariel, Courier, Default Sans Serif, Helvetica, Palatino, Symbol, Times New Roman, and many more.

Specified by:

getFontFace in interface DViewColumn

Returns:

font face of data

See Also:

DViewColumn.getFontFace()

getFontPointSize

public int getFontPointSize()

The font point size of data in a column.

Specified by:

getFontPointSize in interface DViewColumn

Returns:

font point size of data

See Also:

DViewColumn.getFontPointSize()

getFontStyle

public int getFontStyle()

The font style of data in a column.

Specified by:

getFontStyle in interface DViewColumn

Returns:

DViewColumn.FONT_PLAIN, DViewColumn.FONT_BOLD, DViewColumn.FONT_ITALIC, DViewColumn.FONT_UNDERLINE, DViewColumn.FONT_STRIKEOUT or DViewColumn.FONT_STRIKETHROUGH

The font style can have multiple values. For example, the style might be DViewColumn.FONT_BOLD, DViewColumn.FONT_ITALIC

You can use DViewColumn.isFontBold(), DViewColumn.isFontItalic(), DViewColumn.isFontStrikethrough() or DViewColumn.isFontUnderline() to query and set the font styles.

See Also:

DViewColumn.getFontStyle()

getFormula

public java.lang.String getFormula()

The formula for a column that is based on a simple function or a formula.

• If the column is based on a formula, this property returns the formula.
• If the column is based on a simple function, this property returns the formula equivalent. For example, if the column is the simple function "Creation Date," this property returns "@Created."
• If the column is based on a field, this property returns an empty string.

Specified by:

getFormula in interface DViewColumn

Returns:

formula for a column

See Also:

DViewColumn.getFormula()

getHeaderAlignment

public int getHeaderAlignment()

The alignment of the header in a column.

Specified by:

getHeaderAlignment in interface DViewColumn

Returns:

DViewColumn.ALIGN_CENTER, DViewColumn.ALIGN_LEFT or DViewColumn.ALIGN_RIGHT

See Also:

DViewColumn.getHeaderAlignment()

getHeaderFontColor

public int getHeaderFontColor()

The font color of the header in a column.

Specified by:

getHeaderFontColor in interface DViewColumn

Returns:

A Domino color index in the range 0-240.

The first 16 color indices are:

DRichTextStyle.COLOR_BLACK, DRichTextStyle.COLOR_BLUE, DRichTextStyle.COLOR_CYAN, DRichTextStyle.COLOR_DARK_BLUE, DRichTextStyle.COLOR_DARK_CYAN, DRichTextStyle.COLOR_DARK_GREEN, DRichTextStyle.COLOR_DARK_MAGENTA, DRichTextStyle.COLOR_DARK_RED, DRichTextStyle.COLOR_DARK_YELLOW, DRichTextStyle.COLOR_GRAY, DRichTextStyle.COLOR_GREEN, DRichTextStyle.COLOR_LIGHT_GRAY, DRichTextStyle.COLOR_MAGENTA, DRichTextStyle.COLOR_RED, DRichTextStyle.COLOR_WHITE, DRichTextStyle.COLOR_YELLOW

See Also:

DViewColumn.getHeaderFontColor()

getHeaderFontFace

public java.lang.String getHeaderFontFace()

The font face of the header in a column.

Typical font faces include Ariel, Courier, Default Sans Serif, Helvetica, Palatino, Symbol, Times New Roman, and many more.

Specified by:

getHeaderFontFace in interface DViewColumn

Returns:

font face of the header

See Also:

DViewColumn.getHeaderFontFace()

getHeaderFontPointSize

public int getHeaderFontPointSize()

The font point size of the header in a column.

Specified by:

getHeaderFontPointSize in interface DViewColumn

Returns:

font point size

See Also:

DViewColumn.getHeaderFontPointSize()

getHeaderFontStyle

public int getHeaderFontStyle()

The font style of the header in a column.

Specified by:

getHeaderFontStyle in interface DViewColumn

Returns:

DViewColumn.FONT_PLAIN, DViewColumn.FONT_BOLD, DViewColumn.FONT_ITALIC, DViewColumn.FONT_UNDERLINE, DViewColumn.FONT_STRIKEOUT, DViewColumn.FONT_STRIKETHROUGH

The font style can have multiple values. For example, the style might be DViewColumn.FONT_BOLD and DViewColumn.FONT_ITALIC.

See Also:

DViewColumn.getHeaderFontStyle()

getItemName

public java.lang.String getItemName()

The programmatic name of a column, which is usually the field (item) name for a column based on a field.

The programmatic name is specified in the Advanced tab of the Column properties box. By default, the programmatic name for a column based on a field is the name of the field. The programmatic name for a column based on a simple action or a formula is a dollar sign followed by a digit or digits -- "$1," "$2," and so on.

Specified by:

getItemName in interface DViewColumn

Returns:

programmatic name of column

See Also:

DViewColumn.getItemName()

getListSep

public int getListSep()

List (multi-value) separator for values in a column.

Specified by:

getListSep in interface DViewColumn

Returns:

DViewColumn.SEP_COMMA, DViewColumn.SEP_NEWLINE, DViewColumn.SEP_NONE, DViewColumn.SEP_SEMICOLON or DViewColumn.SEP_SPACE

See Also:

DViewColumn.getListSep()

getNumberAttrib

public int getNumberAttrib()

Attributes for numeric values in a column.

Specified by:

getNumberAttrib in interface DViewColumn

Returns:

DViewColumn.ATTR_PARENS (parentheses on negative numbers), DViewColumn.ATTR_PERCENT (percent sign), or DViewColumn.ATTR_PUNCTUATED (punctuated at thousandths)

The number attribute can have multiple values. For example, the attribute might be DViewColumn.ATTR_PARENS and DViewColumn.ATTR_PUNCTUATED.

See Also:

DViewColumn.getNumberAttrib()

getNumberDigits

public int getNumberDigits()

Number of decimal places for numeric values in a column.

Specified by:

getNumberDigits in interface DViewColumn

Returns:

Number of decimal places for numeric values

See Also:

DViewColumn.getNumberDigits()

getNumberFormat

public int getNumberFormat()

Format for numeric values in a column.

Specified by:

getNumberFormat in interface DViewColumn

Returns:

DViewColumn.FMT_CURRENCY, DViewColumn.FMT_FIXED, DViewColumn.FMT_GENERAL or DViewColumn.FMT_SCIENTIFIC

See Also:

DViewColumn.getNumberFormat()

getPosition

public int getPosition()

The position of a column in its view. Columns are numbered from left to right, starting with 1.

The Columns property in View returns a vector of DDViewColumn objects. The vector is zero-based, so the first element in the vector is element 0 and contains the DViewColumn at position 1. The second element in the vector is element 1 and contains the DViewColumn at position 2, and so on. Remember to add one to the vector index to get the correct position value.

Specified by:

getPosition in interface DViewColumn

Returns:

position of column

See Also:

DViewColumn.getPosition()

getResortToViewName

public java.lang.String getResortToViewName()

The name of the target view for a user-sorted column that allows the user to change to another view.

Specified by:

getResortToViewName in interface DViewColumn

Returns:

name of the target view

See Also:

DViewColumn.getResortToViewName()

getSecondaryResortColumnIndex

public int getSecondaryResortColumnIndex()

The index of the secondary sorting column of a user-sorted column that allows a secondary sorting column.

The index of the first column is 0, the second 1, and so on.

Specified by:

getSecondaryResortColumnIndex in interface DViewColumn

Returns:

index of the secondary sorting column

See Also:

DViewColumn.getSecondaryResortColumnIndex()

getTimeDateFmt

public int getTimeDateFmt()

The format of time-date data in a column.

Specified by:

getTimeDateFmt in interface DViewColumn

Returns:

DViewColumn.FMT_DATE (Date only), DViewColumn.FMT_DATETIME (Date and time), DViewColumn.FMT_TIME (Time only) or DViewColumn.FMT_TODAYTIME (Date or 'Today' or 'Yesterday' -- and time)

See Also:

DViewColumn.getTimeDateFmt()

getTimeFmt

public int getTimeFmt()

The format of time data in a column.

Specified by:

getTimeFmt in interface DViewColumn

Returns:

DViewColumn.FMT_HM (hour and minute), DViewColumn.FMT_HMS (hour, minute, and second), DViewColumn.FMT_H (hour only) or DViewColumn.FMT_ALL (hour, minute, second, and hundredths of a second)

See Also:

DViewColumn.getTimeFmt()

getTimeZoneFmt

public int getTimeZoneFmt()

The format of the zone in a time-date column value.

Specified by:

getTimeZoneFmt in interface DViewColumn

Returns:

DViewColumn.FMT_ALWAYS (always show time zone), DViewColumn.FMT_NEVER (never show time zone), DViewColumn.FMT_SOMETIMES (show time zone if the time is not local)

See Also:

DViewColumn.getTimeZoneFmt()

getTitle

public java.lang.String getTitle()

The title of a column or an empty string if the column does not have a title.

Specified by:

getTitle in interface DViewColumn

Returns:

the view title

See Also:

DViewColumn.getTitle()

getWidth

public int getWidth()

The width of a column.

Specified by:

getWidth in interface DViewColumn

Returns:

width of a column

See Also:

DViewColumn.getWidth()

isAccentSensitiveSort

public boolean isAccentSensitiveSort()

Indicates whether an auto-sorted column is sorted with regard to accent.

Legal values

Specified by:

isAccentSensitiveSort in interface DViewColumn

Returns:

true if the column is sorted with regard to accent, false if the column is sorted without regard to accent

Usage

DViewColumn.isSorted() must be true for this property to be effective.

See Also:

DViewColumn.isAccentSensitiveSort()

isCaseSensitiveSort

public boolean isCaseSensitiveSort()

Indicates whether an auto-sorted column is sorted with regard to case.

Specified by:

isCaseSensitiveSort in interface DViewColumn

Returns:

true if the column is sorted with regard to case, false if the column is sorted without regard to case

DViewColumn.isSorted() must be true for this property to be effective.

See Also:

DViewColumn.isCaseSensitiveSort()

isCategory

public boolean isCategory()

Indicates whether a column is categorized.

Specified by:

isCategory in interface DViewColumn

Returns:

true if the column is categorized, false if the column is not categorized

If isCategory returns true, isSorted also returns true, since columns that are categorized must also be sorted.

See Also:

DViewColumn.isCategory()

isField

public boolean isField()

Indicates whether a column value is based on a field value.

Specified by:

isField in interface DViewColumn

Returns:

true if the column is based on a field value, false if the column is not based on a field value

If you specify a column as a formula whose value is the name of a field, the column is considered a field. The formula must contain only the name of the field. For example, "Subject" is a field but "@Trim(Subject)" is a formula.

This property returns false if the column is based on a simple function or formula.

See Also:

DViewColumn.isField()

isFontBold

public boolean isFontBold()

Indicates whether the font style for a column includes bold.

Specified by:

isFontBold in interface DViewColumn

Returns:

true if the font style includes bold, false if the font style does not include bold

See Also:

DViewColumn.isFontBold()

isFontItalic

public boolean isFontItalic()

Indicates whether the font style for a column includes italic.

Specified by:

isFontItalic in interface DViewColumn

Returns:

true if the font style includes italic, false if the font style does not include italic

See Also:

DViewColumn.isFontItalic()

isFontStrikethrough

public boolean isFontStrikethrough()

Indicates whether the font style for a column includes strikethrough.

Specified by:

isFontStrikethrough in interface DViewColumn

Returns:

true if the font style includes strikethrough, false if the font style does not include strikethrough

See Also:

DViewColumn.isFontStrikethrough()

isFontUnderline

public boolean isFontUnderline()

Indicates whether the font style for a column includes underline.

Specified by:

isFontUnderline in interface DViewColumn

Returns:

true if the font style includes underline, false if the font style does not include underline

See Also:

DViewColumn.isFontUnderline()

isFormula

public boolean isFormula()

Indicates whether a column value is based on a simple function or a formula.

Specified by:

isFormula in interface DViewColumn

Returns:

true if the column is based on a simple function or formula, false if the column is not based on a simple function or formula

If you specify a column as a formula whose value is the name of a field, the column is considered a field. The formula must contain only the name of the field. For example, "Subject" is a field but "@Trim(Subject)" is a formula.

This property returns false if the column is based on a field value.

See Also:

DViewColumn.isFormula()

isHeaderFontBold

public boolean isHeaderFontBold()

Indicates whether the header font style for a column includes bold.

Specified by:

isHeaderFontBold in interface DViewColumn

Returns:

true if the header font style includes bold, false if the header font style does not include bold

See Also:

DViewColumn.isHeaderFontBold()

isHeaderFontItalic

public boolean isHeaderFontItalic()

Indicates whether the header font style for a column includes italic.

Specified by:

isHeaderFontItalic in interface DViewColumn

Returns:

true if the header font style includes italic, false if the header font style does not include italic

See Also:

DViewColumn.isHeaderFontItalic()

isHeaderFontStrikethrough

public boolean isHeaderFontStrikethrough()

Indicates whether the header font style for a column includes strikethrough.

Specified by:

isHeaderFontStrikethrough in interface DViewColumn

Returns:

true if the header font style includes strikethrough, false if the header font style does not include strikethrough

See Also:

DViewColumn.isHeaderFontStrikethrough()

isHeaderFontUnderline

public boolean isHeaderFontUnderline()

Indicates whether the header font style for a column includes underline.

Specified by:

isHeaderFontUnderline in interface DViewColumn

Returns:

true if the header font style includes underline, false if the header font style does not include underline

See Also:

DViewColumn.isHeaderFontUnderline()

isHidden

public boolean isHidden()

Indicates whether a column is hidden.

Legal values

Specified by:

isHidden in interface DViewColumn

Returns:

true if the column is hidden, false if the column is not hidden

See Also:

DViewColumn.isHidden()

isHideDetail

public boolean isHideDetail()

Indicates whether the details for total columns are hidden.

Specified by:

isHideDetail in interface DViewColumn

Returns:

true if the details for totals are hidden, false if the details for totals are displayed

See Also:

DViewColumn.isHideDetail()

isIcon

public boolean isIcon()

Indicates whether column values are displayed as icons.

Specified by:

isIcon in interface DViewColumn

Returns:

true if column values are displayed as icons, false if column values are not displayed as icons

See Also:

DViewColumn.isIcon()

isNumberAttribParens

public boolean isNumberAttribParens()

Indicates whether the number attributes for a column include parentheses for negative numbers.

Specified by:

isNumberAttribParens in interface DViewColumn

Returns:

true if the number attributes include parentheses, false if the number attributes do not include parentheses

See Also:

DViewColumn.isNumberAttribParens()

isNumberAttribPercent

public boolean isNumberAttribPercent()

Indicates whether the number attributes for a column include displaying the number as a percentage.

Specified by:

isNumberAttribPercent in interface DViewColumn

Returns:

true if the number attributes include percent, false if the number attributes do not include percent

See Also:

DViewColumn.isNumberAttribPercent()

isNumberAttribPunctuated

public boolean isNumberAttribPunctuated()

Indicates whether the number attributes for a column include punctuation at thousandths.

Specified by:

isNumberAttribPunctuated in interface DViewColumn

Returns:

true if the number attributes include punctuation, false if the number attributes do not include punctuation

See Also:

DViewColumn.isNumberAttribPunctuated()

isResize

public boolean isResize()

Indicates whether a column is resizable.

Legal values

Specified by:

isResize in interface DViewColumn

Returns:

true if a column is resizable, false if a column is not resizable

See Also:

DViewColumn.isResize()

isResortAscending

public boolean isResortAscending()

Indicates whether a column is a user-sorted column that can be sorted in ascending order.

Legal values

Specified by:

isResortAscending in interface DViewColumn

Returns:

true if the column is ascending user-sorted, false if the column is not ascending user-sorted

Usage

In the sort tab for column properties, "Click on column head to sort" indicates a user-sorted column. "Ascending" or "Both" indicates ascending.

See Also:

DViewColumn.isResortAscending()

isResortDescending

public boolean isResortDescending()

Indicates whether a column is a user-sorted column that can be sorted in descending order.

Legal values

Specified by:

isResortDescending in interface DViewColumn

Returns:

true if the column is descending user-sorted, false if the column is not descending user-sorted

Usage

In the sort tab for column properties, "Click on column head to sort" indicates a user-sorted column. "Descending" or "Both" indicates ascending.

See Also:

DViewColumn.isResortDescending()

isResortToView

public boolean isResortToView()

Indicates whether a column is a user-sorted column that allows the user to change to another view.

Specified by:

isResortToView in interface DViewColumn

Returns:

true if the column is user-sorted and allows changing to another view, false if the column is not user-sorted and allows changing to another view

In the sort tab for column properties, "Click on column head to sort" indicates a user-sorted column. "Change To View" indicates allowing the user to change to another view.

If a user-sorted column is ascending or descending, this property is false.

See Also:

DViewColumn.isResortToView()

isResponse

public boolean isResponse()

Indicates whether a column contains only response documents.

Specified by:

isResponse in interface DViewColumn

Returns:

whether a column contains only response documents

See Also:

DViewColumn.isResponse()

isSecondaryResort

public boolean isSecondaryResort()

Indicates whether an ascending or descending user-sorted column has a secondary sorting column.

Specified by:

isSecondaryResort in interface DViewColumn

Returns:

true if a column is a secondary sorting column, false if a column is a secondary sorting column

In the sort tab for column properties, "Click on column head to sort" indicates a user-sorted column. For ascending and descending sorts, you can choose to have a secondary sort column.

If a user-sorted column is "Change to view," this property is false.

The column must be selected through the Lotus Domino Designer UI.

The sort is ascending unless DViewColumn.isSecondaryResortDescending() is true.

DViewColumn.isResortAscending() or DViewColumn.isResortDescending() must be true for this property to be effective.

See Also:

DViewColumn.isSecondaryResort()

isSecondaryResortDescending

public boolean isSecondaryResortDescending()

Indicates whether a secondary sorting column for a user-sorted column is sorted in descending order.

Specified by:

isSecondaryResortDescending in interface DViewColumn

Returns:

true if a secondary sorting column is descending, false if a secondary sorting column is ascending

DViewColumn.isSecondaryResort() must be true for this property to be effective.

See Also:

DViewColumn.isSecondaryResortDescending()

isShowTwistie

public boolean isShowTwistie()

Indicates whether an expandable column displays a twistie.

Legal values

Specified by:

isShowTwistie in interface DViewColumn

Returns:

true if an expandable column displays a twistie, false if an expandable column does not display a twistie

See Also:

DViewColumn.isShowTwistie()

isSortDescending

public boolean isSortDescending()

Indicates whether an auto-sorted column is sorted in descending order.

Specified by:

isSortDescending in interface DViewColumn

Returns:

true if a sorted column is descending, false if a sorted column is ascending

In the sort tab for column properties, the"Descending" button indicates a descending auto-sorted column.

DViewColumn.isSorted() must be true for this property to be effective.

See Also:

DViewColumn.isSortDescending()

isSorted

public boolean isSorted()

Indicates whether a column is an auto-sorted column.

This property is false if the column is user-sorted but not auto-sorted.

Specified by:

isSorted in interface DViewColumn

Returns:

true if the column is auto-sorted, false if the column is not auto-sorted

See Also:

DViewColumn.isSorted()

setAccentSensitiveSort

public void setAccentSensitiveSort(boolean arg1)

Indicates whether an auto-sorted column is sorted with regard to accent.

Specified by:

setAccentSensitiveSort in interface DViewColumn

Parameters:

arg1 - true if the column is sorted with regard to accent, false if the column is sorted without regard to accent

Usage

DViewColumn.isSorted() must be true for this property to be effective.

See Also:

DViewColumn.setAccentSensitiveSort(boolean)

setAlignment

public void setAlignment(int alignment)

The alignment of data in a column.

Specified by:

setAlignment in interface DViewColumn

Parameters:

alignment - the new alignment

See Also:

DViewColumn.setAlignment(int)

setCaseSensitiveSort

public void setCaseSensitiveSort(boolean arg1)

Indicates whether an auto-sorted column is sorted with regard to case.

Legal values

Specified by:

setCaseSensitiveSort in interface DViewColumn

Parameters:

arg1 - true if the column is sorted with regard to case, false if the column is sorted without regard to case

DViewColumn.isSorted() must be true for this property to be effective.

See Also:

DViewColumn.setCaseSensitiveSort(boolean)

setDateFmt

public void setDateFmt(int arg1)

The format of date data in a column.

Specified by:

setDateFmt in interface DViewColumn

Parameters:

arg1 - DViewColumn.FMT_MD (month and day), DViewColumn.FMT_YM (year and month), DViewColumn.FMT_Y4M (4-digit year and month) or DViewColumn.FMT_YMD (year, month, and day)

See Also:

DViewColumn.setDateFmt(int)

setFontBold

public void setFontBold(boolean arg1)

Indicates whether the font style for a column includes bold.

Specified by:

setFontBold in interface DViewColumn

Parameters:

arg1 - true if the font style includes bold, false if the font style does not include bold

See Also:

DViewColumn.setFontBold(boolean)

setFontColor

public void setFontColor(int arg1)

The font color of data in a column.

Specified by:

setFontColor in interface DViewColumn

Parameters:

arg1 - a Domino color index in the range 0-240.

The first 16 color indices are:

DRichTextStyle.COLOR_BLACK, DRichTextStyle.COLOR_BLUE, DRichTextStyle.COLOR_CYAN, DRichTextStyle.COLOR_DARK_BLUE, DRichTextStyle.COLOR_DARK_CYAN, DRichTextStyle.COLOR_DARK_GREEN, DRichTextStyle.COLOR_DARK_MAGENTA, DRichTextStyle.COLOR_DARK_RED, DRichTextStyle.COLOR_DARK_YELLOW, DRichTextStyle.COLOR_GRAY, DRichTextStyle.COLOR_GREEN, DRichTextStyle.COLOR_LIGHT_GRAY, DRichTextStyle.COLOR_MAGENTA, DRichTextStyle.COLOR_RED, DRichTextStyle.COLOR_WHITE, DRichTextStyle.COLOR_YELLOW

See Also:

DViewColumn.setFontColor(int)

setFontFace

public void setFontFace(java.lang.String arg1)

The font face of data in a column.

Typical font faces include Ariel, Courier, Default Sans Serif, Helvetica, Palatino, Symbol, Times New Roman, and many more.

Specified by:

setFontFace in interface DViewColumn

Parameters:

arg1 - font face of data

See Also:

DViewColumn.setFontFace(java.lang.String)

setFontItalic

public void setFontItalic(boolean arg1)

Indicates whether the font style for a column includes italic.

Specified by:

setFontItalic in interface DViewColumn

Parameters:

arg1 - true if the font style includes italic, false if the font style does not include italic

See Also:

DViewColumn.setFontItalic(boolean)

setFontPointSize

public void setFontPointSize(int arg1)

The font point size of data in a column.

Specified by:

setFontPointSize in interface DViewColumn

Parameters:

arg1 - font point size

See Also:

DViewColumn.setFontPointSize(int)

setFontStrikethrough

public void setFontStrikethrough(boolean arg1)

Indicates whether the font style for a column includes strikethrough.

Specified by:

setFontStrikethrough in interface DViewColumn

Parameters:

arg1 - true if the font style includes strikethrough, false if the font style does not include strikethrough

See Also:

DViewColumn.setFontStrikethrough(boolean)

setFontStyle

public void setFontStyle(int arg1)

The font style of data in a column.

Specified by:

setFontStyle in interface DViewColumn

Parameters:

arg1 - DViewColumn.FONT_PLAIN, DViewColumn.FONT_BOLD, DViewColumn.FONT_ITALIC DViewColumn.FONT_UNDERLINE, DViewColumn.FONT_STRIKEOUT or DViewColumn.FONT_STRIKETHROUGH

The font style can have multiple values. For example, the style might be DViewColumn.FONT_BOLD and DViewColumn.FONT_ITALIC.

See Also:

DViewColumn.setFontStyle(int)

setFontUnderline

public void setFontUnderline(boolean arg1)

Indicates whether the font style for a column includes underline.

Specified by:

setFontUnderline in interface DViewColumn

Parameters:

arg1 - true if the font style includes underline, false if the font style does not include underline

See Also:

DViewColumn.setFontUnderline(boolean)

setFormula

public void setFormula(java.lang.String arg1)

The formula for a column that is based on a simple function or a formula.

• This property replaces the existing formula. The replacement formula must be valid and cannot be an empty string.
• If the replacement formula is equivalent to a simple function, the column basis changes to the simple function.
• If the formula is simply the name of a field, the column basis changes to the value of that field, IsField becomes true, and IsFormula becomes false.
• If a formula (that is not simply the name of a field) is written to a column based on a field, the column basis changes to a simple function or a formula, IsFormula becomes true, and IsField becomes false.

Specified by:

setFormula in interface DViewColumn

Parameters:

arg1 - formula for a column

See Also:

DViewColumn.setFormula(java.lang.String)

setHeaderAlignment

public void setHeaderAlignment(int arg1)

The alignment of the header in a column.

Specified by:

setHeaderAlignment in interface DViewColumn

Parameters:

arg1 - DViewColumn.ALIGN_CENTER, DViewColumn.ALIGN_LEFT DViewColumn.ALIGN_RIGHT

See Also:

DViewColumn.setHeaderAlignment(int)

setHeaderFontBold

public void setHeaderFontBold(boolean arg1)

Indicates whether the header font style for a column includes bold.

Specified by:

setHeaderFontBold in interface DViewColumn

Parameters:

arg1 - true if the header font style includes bold, false if the header font style does not include bold

See Also:

DViewColumn.setHeaderFontBold(boolean)

setHeaderFontColor

public void setHeaderFontColor(int arg1)

The font color of the header in a column.

Specified by:

setHeaderFontColor in interface DViewColumn

Parameters:

arg1 - a Domino color index in the range 0-240.

The first 16 color indices are:

DRichTextStyle.COLOR_BLACK, DRichTextStyle.COLOR_BLUE, DRichTextStyle.COLOR_CYAN, DRichTextStyle.COLOR_DARK_BLUE, DRichTextStyle.COLOR_DARK_CYAN, DRichTextStyle.COLOR_DARK_GREEN, DRichTextStyle.COLOR_DARK_MAGENTA, DRichTextStyle.COLOR_DARK_RED, DRichTextStyle.COLOR_DARK_YELLOW, DRichTextStyle.COLOR_GRAY, DRichTextStyle.COLOR_GREEN, DRichTextStyle.COLOR_LIGHT_GRAY, DRichTextStyle.COLOR_MAGENTA, DRichTextStyle.COLOR_RED, DRichTextStyle.COLOR_WHITE, DRichTextStyle.COLOR_YELLOW

See Also:

DViewColumn.setHeaderFontColor(int)

setHeaderFontFace

public void setHeaderFontFace(java.lang.String arg1)

The font face of the header in a column.

Typical font faces include Ariel, Courier, Default Sans Serif, Helvetica, Palatino, Symbol, Times New Roman, and many more.

Specified by:

setHeaderFontFace in interface DViewColumn

Parameters:

arg1 - font face of header

See Also:

DViewColumn.setHeaderFontFace(java.lang.String)

setHeaderFontItalic

public void setHeaderFontItalic(boolean arg1)

Indicates whether the header font style for a column includes italic.

Specified by:

setHeaderFontItalic in interface DViewColumn

Parameters:

arg1 - true if the header font style includes italic, false if the header font style does not include italic

See Also:

DViewColumn.setHeaderFontItalic(boolean)

setHeaderFontPointSize

public void setHeaderFontPointSize(int arg1)

The font point size of the header in a column.

Specified by:

setHeaderFontPointSize in interface DViewColumn

Parameters:

arg1 - font point size of the header

See Also:

DViewColumn.setHeaderFontPointSize(int)

setHeaderFontStrikethrough

public void setHeaderFontStrikethrough(boolean arg1)

Indicates whether the header font style for a column includes strikethrough.

Specified by:

setHeaderFontStrikethrough in interface DViewColumn

Parameters:

arg1 - true if the header font style includes strikethrough, false if the header font style does not include strikethrough

See Also:

DViewColumn.setHeaderFontStrikethrough(boolean)

setHeaderFontStyle

public void setHeaderFontStyle(int arg1)

The font style of the header in a column.

Specified by:

setHeaderFontStyle in interface DViewColumn

Parameters:

arg1 - DViewColumn.FONT_PLAIN, DViewColumn.FONT_BOLD

#FONT_ITALIC}, DViewColumn.FONT_UNDERLINE

#FONT_STRIKEOUT} or DViewColumn.FONT_STRIKETHROUGH

The font style can have multiple values. For example, the style might be DViewColumn.FONT_BOLD and DViewColumn.FONT_ITALIC.

See Also:

DViewColumn.setHeaderFontStyle(int)

setHeaderFontUnderline

public void setHeaderFontUnderline(boolean arg1)

Indicates whether the header font style for a column includes underline.

Specified by:

setHeaderFontUnderline in interface DViewColumn

Parameters:

arg1 - true if the header font style includes underline, false if the header font style does not include underline

See Also:

DViewColumn.setHeaderFontUnderline(boolean)

setHidden

public void setHidden(boolean flag)

Indicates whether a column is hidden.

Specified by:

setHidden in interface DViewColumn

Parameters:

flag - true if the column is hidden or false if the column is not hidden

See Also:

DViewColumn.setHidden(boolean)

setHideDetail

public void setHideDetail(boolean arg1)

Indicates whether the details for total columns are hidden.

Specified by:

setHideDetail in interface DViewColumn

Parameters:

arg1 - true if the details for totals are hidden, false if the details for totals are displayed

See Also:

DViewColumn.setHideDetail(boolean)

setListSep

public void setListSep(int arg1)

List (multi-value) separator for values in a column.

Specified by:

setListSep in interface DViewColumn

Parameters:

arg1 - DViewColumn.SEP_COMMA, DViewColumn.SEP_NEWLINE, DViewColumn.SEP_NONE, DViewColumn.SEP_SEMICOLON or DViewColumn.SEP_SPACE

See Also:

DViewColumn.setListSep(int)

setNumberAttrib

public void setNumberAttrib(int arg1)

Attributes for numeric values in a column.

Specified by:

setNumberAttrib in interface DViewColumn

Parameters:

arg1 - DViewColumn.ATTR_PARENS (parentheses on negative numbers), DViewColumn.ATTR_PERCENT (percent sign) or DViewColumn.ATTR_PUNCTUATED (punctuated at thousandths)

The number attribute can have multiple values. For example, the attribute might be DViewColumn.ATTR_PARENS and DViewColumn.ATTR_PUNCTUATED.

See Also:

DViewColumn.setNumberAttrib(int)

setNumberAttribParens

public void setNumberAttribParens(boolean arg1)

Indicates whether the number attributes for a column include parentheses for negative numbers.

Specified by:

setNumberAttribParens in interface DViewColumn

Parameters:

arg1 - true if the number attributes include parentheses, false if the number attributes do not include parentheses

See Also:

DViewColumn.setNumberAttribParens(boolean)

setNumberAttribPercent

public void setNumberAttribPercent(boolean arg1)

Indicates whether the number attributes for a column include displaying the number as a percentage.

Specified by:

setNumberAttribPercent in interface DViewColumn

Parameters:

arg1 - true if the number attributes include percent, false if the number attributes do not include percent

See Also:

DViewColumn.setNumberAttribPercent(boolean)

setNumberAttribPunctuated

public void setNumberAttribPunctuated(boolean arg1)

Indicates whether the number attributes for a column include punctuation at thousandths.

Specified by:

setNumberAttribPunctuated in interface DViewColumn

Parameters:

arg1 - true if the number attributes include punctuation, false if the number attributes do not include punctuation

See Also:

DViewColumn.setNumberAttribPunctuated(boolean)

setNumberDigits

public void setNumberDigits(int arg1)

Number of decimal places for numeric values in a column.

Specified by:

setNumberDigits in interface DViewColumn

Parameters:

arg1 - number of decimal places

See Also:

DViewColumn.setNumberDigits(int)

setNumberFormat

public void setNumberFormat(int arg1)

Format for numeric values in a column.

Specified by:

setNumberFormat in interface DViewColumn

Parameters:

arg1 - DViewColumn.FMT_CURRENCY, DViewColumn.FMT_FIXED DViewColumn.FMT_GENERAL or DViewColumn.FMT_SCIENTIFIC

See Also:

DViewColumn.setNumberFormat(int)

setResize

public void setResize(boolean arg1)

Indicates whether a column is resizable.

Specified by:

setResize in interface DViewColumn

Parameters:

arg1 - true if a column is resizable, false if a column is not resizable

See Also:

DViewColumn.setResize(boolean)

setResortAscending

public void setResortAscending(boolean arg1)

Indicates whether a column is a user-sorted column that can be sorted in ascending order.

Specified by:

setResortAscending in interface DViewColumn

Parameters:

arg1 - true if the column is ascending user-sorted, false if the column is not ascending user-sorted

In the sort tab for column properties, "Click on column head to sort" indicates a user-sorted column. "Ascending" or "Both" indicates ascending.

See Also:

DViewColumn.setResortAscending(boolean)

setResortDescending

public void setResortDescending(boolean arg1)

Indicates whether a column is a user-sorted column that can be sorted in descending order.

Specified by:

setResortDescending in interface DViewColumn

Parameters:

arg1 - true if the column is descending user-sorted, false if the column is not descending user-sorted

In the sort tab for column properties, "Click on column head to sort" indicates a user-sorted column. "Descending" or "Both" indicates ascending.

See Also:

DViewColumn.setResortDescending(boolean)

setResortToView

public void setResortToView(boolean arg1)

Indicates whether a column is a user-sorted column that allows the user to change to another view.

Specified by:

setResortToView in interface DViewColumn

Parameters:

arg1 - true if the column is user-sorted and allows changing to another view, false if the column is not user-sorted and allows changing to another view

In the sort tab for column properties, "Click on column head to sort" indicates a user-sorted column. "Change To View" indicates allowing the user to change to another view.

If a user-sorted column is ascending or descending, this property is false.

See Also:

DViewColumn.setResortToView(boolean)

setResortToViewName

public void setResortToViewName(java.lang.String arg1)

The name of the target view for a user-sorted column that allows the user to change to another view.

Specified by:

setResortToViewName in interface DViewColumn

Parameters:

arg1 - name of target view

See Also:

DViewColumn.setResortToViewName(java.lang.String)

setSecondaryResort

public void setSecondaryResort(boolean arg1)

Indicates whether an ascending or descending user-sorted column has a secondary sorting column.

Specified by:

setSecondaryResort in interface DViewColumn

Parameters:

arg1 - true if a column is a secondary sorting column, false if a column is a secondary sorting column

In the sort tab for column properties, "Click on column head to sort" indicates a user-sorted column. For ascending and descending sorts, you can choose to have a secondary sort column.

If a user-sorted column is "Change to view," this property is false.

The column must be selected through the Lotus Domino Designer UI.

The sort is ascending unless DViewColumn.isSecondaryResortDescending() is true.

See Also:

DViewColumn.setSecondaryResort(boolean)

setSecondaryResortColumnIndex

public void setSecondaryResortColumnIndex(int arg1)

The index of the secondary sorting column of a user-sorted column that allows a secondary sorting column.

The index of the first column is 0, the second 1, and so on.

Specified by:

setSecondaryResortColumnIndex in interface DViewColumn

Parameters:

arg1 - index of the secondary sorting column

See Also:

DViewColumn.setSecondaryResortColumnIndex(int)

setSecondaryResortDescending

public void setSecondaryResortDescending(boolean arg1)

Indicates whether a secondary sorting column for a user-sorted column is sorted in descending order.

Specified by:

setSecondaryResortDescending in interface DViewColumn

Parameters:

arg1 - true if a secondary sorting column is descending, false if a secondary sorting column is ascending

DViewColumn.isSecondaryResort() must be true for this property to be effective.

See Also:

DViewColumn.setSecondaryResortDescending(boolean)

setShowTwistie

public void setShowTwistie(boolean arg1)

Indicates whether an expandable column displays a twistie.

Specified by:

setShowTwistie in interface DViewColumn

Parameters:

arg1 - true if an expandable column displays a twistie, false if an expandable column does not display a twistie

See Also:

DViewColumn.setShowTwistie(boolean)

setSortDescending

public void setSortDescending(boolean arg1)

Indicates whether an auto-sorted column is sorted in descending order.

Specified by:

setSortDescending in interface DViewColumn

Parameters:

arg1 - true if a sorted column is descending, false if a sorted column is ascending

In the sort tab for column properties, the"Descending" button indicates a descending auto-sorted column.

DViewColumn.isSorted() must be true for this property to be effective.

See Also:

DViewColumn.setSortDescending(boolean)

setSorted

public void setSorted(boolean arg1)

Indicates whether a column is an auto-sorted column.

Legal values

Specified by:

setSorted in interface DViewColumn

Parameters:

arg1 - true if the column is auto-sorted, false if the column is not auto-sorted

Usage

In the sort tab for column properties, the "Ascending" or "Descending" button indicates an auto-sorted column.

This property is false if the column is user-sorted but not auto-sorted.

See Also:

DViewColumn.setSorted(boolean)

setTimeDateFmt

public void setTimeDateFmt(int arg1)

The format of time-date data in a column.

Specified by:

setTimeDateFmt in interface DViewColumn

Parameters:

arg1 - DViewColumn.FMT_DATE (Date only), DViewColumn.FMT_DATETIME (Date and time), DViewColumn.FMT_TIME (Time only), DViewColumn.FMT_TODAYTIME (Date or 'Today' or 'Yesterday' -- and time)

See Also:

DViewColumn.setTimeDateFmt(int)

setTimeFmt

public void setTimeFmt(int arg1)

The format of time data in a column.

Specified by:

setTimeFmt in interface DViewColumn

Parameters:

arg1 - DViewColumn.FMT_HM (hour and minute), DViewColumn.FMT_HMS (hour, minute, and second), DViewColumn.FMT_H (hour only) DViewColumn.FMT_ALL (hour, minute, second, and hundredths of a second)

See Also:

DViewColumn.setTimeFmt(int)

setTimeZoneFmt

public void setTimeZoneFmt(int arg1)

The format of the zone in a time-date column value.

Specified by:

setTimeZoneFmt in interface DViewColumn

Parameters:

arg1 - DViewColumn.FMT_ALWAYS (always show time zone), DViewColumn.FMT_NEVER (never show time zone) or DViewColumn.FMT_SOMETIMES (show time zone if the time is not local)

See Also:

DViewColumn.setTimeZoneFmt(int)

setTitle

public void setTitle(java.lang.String title)

The title of a column or an empty string if the column does not have a title.

Specified by:

setTitle in interface DViewColumn

Parameters:

title - the new title

See Also:

DViewColumn.setTitle(java.lang.String)

setWidth

public void setWidth(int arg1)

The width of a column.

Specified by:

setWidth in interface DViewColumn

Parameters:

arg1 - width of column

See Also:

DViewColumn.setWidth(int)

toString

public java.lang.String toString()

Returns a short description of an instance.

Specified by:

toString in interface DBase

Overrides:

toString in class java.lang.Object

Returns:

short description of an instance

See Also:

Object.toString()