de.bea.domingo
Interface DViewColumn

All Known Implementing Classes:
ViewColumnProxy

public interface DViewColumn

Represents a column in a view or folder.

Author:
Kurt Riede

Field Summary
static int ALIGN_CENTER
          Constant for alignments.
static int ALIGN_LEFT
          Constant for alignments.
static int ALIGN_RIGHT
          Constant for alignments.
static int ATTR_PARENS
          Constant for number attributes.
static int ATTR_PERCENT
          Constant for number attributes.
static int ATTR_PUNCTUATED
          Constant for number attributes.
static int FMT_ALL
          Constant for number formatting.
static int FMT_ALWAYS
          Constant for date formatting.
static int FMT_CURRENCY
          Constant for number formatting.
static int FMT_DATE
          Constant for date formatting.
static int FMT_DATETIME
          Constant for date formatting.
static int FMT_FIXED
          Constant for number formatting.
static int FMT_GENERAL
          Constant for number formatting.
static int FMT_H
          Constant for number formatting.
static int FMT_HM
          Constant for date formatting.
static int FMT_HMS
          Constant for date formatting.
static int FMT_MD
          Constant for date formatting.
static int FMT_NEVER
          Constant for date formatting.
static int FMT_SCIENTIFIC
          Constant for number formatting.
static int FMT_SOMETIMES
          Constant for date formatting.
static int FMT_TIME
          Constant for date formatting.
static int FMT_TODAYTIME
          Constant for date formatting.
static int FMT_Y4M
          Constant for date formatting.
static int FMT_YM
          Constant for date formatting.
static int FMT_YMD
          Constant for date formatting.
static int FONT_BOLD
          Constant for text formatting.
static int FONT_ITALIC
          Constant for text formatting.
static int FONT_PLAIN
          Constant for text formatting.
static int FONT_STRIKEOUT
          Constant for text formatting.
static int FONT_STRIKETHROUGH
          Constant for text formatting.
static int FONT_UNDERLINE
          Constant for text formatting.
static int SEP_COMMA
          Constant for seperators.
static int SEP_NEWLINE
          Constant for seperators.
static int SEP_NONE
          Constant for seperators.
static int SEP_SEMICOLON
          Constant for seperators.
static int SEP_SPACE
          Constant for seperators.
 
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.
 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.
 

Field Detail

ALIGN_LEFT

static final int ALIGN_LEFT
Constant for alignments.

See Also:
Constant Field Values

ALIGN_RIGHT

static final int ALIGN_RIGHT
Constant for alignments.

See Also:
Constant Field Values

ALIGN_CENTER

static final int ALIGN_CENTER
Constant for alignments.

See Also:
Constant Field Values

SEP_SPACE

static final int SEP_SPACE
Constant for seperators.

See Also:
Constant Field Values

SEP_COMMA

static final int SEP_COMMA
Constant for seperators.

See Also:
Constant Field Values

SEP_SEMICOLON

static final int SEP_SEMICOLON
Constant for seperators.

See Also:
Constant Field Values

SEP_NEWLINE

static final int SEP_NEWLINE
Constant for seperators.

See Also:
Constant Field Values

SEP_NONE

static final int SEP_NONE
Constant for seperators.

See Also:
Constant Field Values

FMT_H

static final int FMT_H
Constant for number formatting.

See Also:
Constant Field Values

FMT_ALL

static final int FMT_ALL
Constant for number formatting.

See Also:
Constant Field Values

FMT_GENERAL

static final int FMT_GENERAL
Constant for number formatting.

See Also:
Constant Field Values

FMT_FIXED

static final int FMT_FIXED
Constant for number formatting.

See Also:
Constant Field Values

FMT_SCIENTIFIC

static final int FMT_SCIENTIFIC
Constant for number formatting.

See Also:
Constant Field Values

FMT_CURRENCY

static final int FMT_CURRENCY
Constant for number formatting.

See Also:
Constant Field Values

ATTR_PUNCTUATED

static final int ATTR_PUNCTUATED
Constant for number attributes.

See Also:
Constant Field Values

ATTR_PARENS

static final int ATTR_PARENS
Constant for number attributes.

See Also:
Constant Field Values

ATTR_PERCENT

static final int ATTR_PERCENT
Constant for number attributes.

See Also:
Constant Field Values

FMT_YMD

static final int FMT_YMD
Constant for date formatting.

See Also:
Constant Field Values

FMT_MD

static final int FMT_MD
Constant for date formatting.

See Also:
Constant Field Values

FMT_YM

static final int FMT_YM
Constant for date formatting.

See Also:
Constant Field Values

FMT_Y4M

static final int FMT_Y4M
Constant for date formatting.

See Also:
Constant Field Values

FMT_HMS

static final int FMT_HMS
Constant for date formatting.

See Also:
Constant Field Values

FMT_HM

static final int FMT_HM
Constant for date formatting.

See Also:
Constant Field Values

FMT_NEVER

static final int FMT_NEVER
Constant for date formatting.

See Also:
Constant Field Values

FMT_SOMETIMES

static final int FMT_SOMETIMES
Constant for date formatting.

See Also:
Constant Field Values

FMT_ALWAYS

static final int FMT_ALWAYS
Constant for date formatting.

See Also:
Constant Field Values

FMT_DATE

static final int FMT_DATE
Constant for date formatting.

See Also:
Constant Field Values

FMT_TIME

static final int FMT_TIME
Constant for date formatting.

See Also:
Constant Field Values

FMT_DATETIME

static final int FMT_DATETIME
Constant for date formatting.

See Also:
Constant Field Values

FMT_TODAYTIME

static final int FMT_TODAYTIME
Constant for date formatting.

See Also:
Constant Field Values

FONT_BOLD

static final int FONT_BOLD
Constant for text formatting.

See Also:
Constant Field Values

FONT_ITALIC

static final int FONT_ITALIC
Constant for text formatting.

See Also:
Constant Field Values

FONT_UNDERLINE

static final int FONT_UNDERLINE
Constant for text formatting.

See Also:
Constant Field Values

FONT_STRIKEOUT

static final int FONT_STRIKEOUT
Constant for text formatting.

See Also:
Constant Field Values

FONT_STRIKETHROUGH

static final int FONT_STRIKETHROUGH
Constant for text formatting.

See Also:
Constant Field Values

FONT_PLAIN

static final int FONT_PLAIN
Constant for text formatting.

See Also:
Constant Field Values
Method Detail

isHidden

boolean isHidden()
Indicates whether a column is hidden.

Legal values

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

getWidth

int getWidth()
The width of a column.

Returns:
width of a column

getTitle

java.lang.String getTitle()
The title of a column or an empty string if the column does not have a title.

Returns:
the view title

setTitle

void setTitle(java.lang.String title)
The title of a column or an empty string if the column does not have a title.

Parameters:
title - the new title

getAlignment

int getAlignment()
The alignment of data in a column.

Returns:
alignment of a column

setAlignment

void setAlignment(int alignment)
The alignment of data in a column.

Parameters:
alignment - the new alignment

isResponse

boolean isResponse()
Indicates whether a column contains only response documents.

Returns:
whether a column contains only response documents

isSorted

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.

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

getFormula

java.lang.String getFormula()
The formula for a column that is based on a simple function or a formula.

Returns:
formula for a column

setHidden

void setHidden(boolean flag)
Indicates whether a column is hidden.

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

setFormula

void setFormula(java.lang.String arg1)
The formula for a column that is based on a simple function or a formula.

Parameters:
arg1 - formula for a column

getPosition

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.

Returns:
position of column

isField

boolean isField()
Indicates whether a column value is based on a field value.

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.


isFormula

boolean isFormula()
Indicates whether a column value is based on a simple function or a formula.

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.


getItemName

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.

Returns:
programmatic name of column

getListSep

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

Returns:
SEP_COMMA, SEP_NEWLINE, SEP_NONE, SEP_SEMICOLON or SEP_SPACE
Since:
Lotus Notes 6.5

getHeaderAlignment

int getHeaderAlignment()
The alignment of the header in a column.

Returns:
ALIGN_CENTER, ALIGN_LEFT or ALIGN_RIGHT
Since:
Lotus Notes 6.5

getFontFace

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.

Returns:
font face of data
Since:
Lotus Notes 6.5

getFontStyle

int getFontStyle()
The font style of data in a column.

Returns:
FONT_PLAIN, FONT_BOLD, FONT_ITALIC, FONT_UNDERLINE, FONT_STRIKEOUT or FONT_STRIKETHROUGH

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

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

Since:
Lotus Notes 6.5

getFontColor

int getFontColor()
The font color of data in a column.

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

Since:
Lotus Notes 6.5

getFontPointSize

int getFontPointSize()
The font point size of data in a column.

Returns:
font point size of data
Since:
Lotus Notes 6.5

getNumberDigits

int getNumberDigits()
Number of decimal places for numeric values in a column.

Returns:
Number of decimal places for numeric values
Since:
Lotus Notes 6.5

getNumberFormat

int getNumberFormat()
Format for numeric values in a column.

Returns:
FMT_CURRENCY, FMT_FIXED, FMT_GENERAL or FMT_SCIENTIFIC
Since:
Lotus Notes 6.5

getNumberAttrib

int getNumberAttrib()
Attributes for numeric values in a column.

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

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

Since:
Lotus Notes 6.5

getDateFmt

int getDateFmt()
The format of date data in a column.

Returns:
FMT_MD (month and day), FMT_YM (year and month), FMT_Y4M (4-digit year and month) or FMT_YMD (year, month, and day)
Since:
Lotus Notes 6.5

getTimeFmt

int getTimeFmt()
The format of time data in a column.

Returns:
FMT_HM (hour and minute), FMT_HMS (hour, minute, and second), FMT_H (hour only) or FMT_ALL (hour, minute, second, and hundredths of a second)
Since:
Lotus Notes 6.5

getTimeZoneFmt

int getTimeZoneFmt()
The format of the zone in a time-date column value.

Returns:
FMT_ALWAYS (always show time zone), FMT_NEVER (never show time zone), FMT_SOMETIMES (show time zone if the time is not local)
Since:
Lotus Notes 6.5

getTimeDateFmt

int getTimeDateFmt()
The format of time-date data in a column.

Returns:
FMT_DATE (Date only), FMT_DATETIME (Date and time), FMT_TIME (Time only) or FMT_TODAYTIME (Date or 'Today' or 'Yesterday' -- and time)
Since:
Lotus Notes 6.5

isCategory

boolean isCategory()
Indicates whether a column is categorized.

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.


isSortDescending

boolean isSortDescending()
Indicates whether an auto-sorted column is sorted in descending order.

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.

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

Since:
Lotus Notes 6.5

isHideDetail

boolean isHideDetail()
Indicates whether the details for total columns are hidden.

Returns:
true if the details for totals are hidden, false if the details for totals are displayed
Since:
Lotus Notes 6.5

isIcon

boolean isIcon()
Indicates whether column values are displayed as icons.

Returns:
true if column values are displayed as icons, false if column values are not displayed as icons
Since:
Lotus Notes 6.5

isResize

boolean isResize()
Indicates whether a column is resizable.

Legal values

Returns:
true if a column is resizable, false if a column is not resizable
Since:
Lotus Notes 6.5

isResortAscending

boolean isResortAscending()
Indicates whether a column is a user-sorted column that can be sorted in ascending order.

Legal values

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.

Since:
Lotus Notes 6.5

isResortDescending

boolean isResortDescending()
Indicates whether a column is a user-sorted column that can be sorted in descending order.

Legal values

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.

Since:
Lotus Notes 6.5

isShowTwistie

boolean isShowTwistie()
Indicates whether an expandable column displays a twistie.

Legal values

Returns:
true if an expandable column displays a twistie, false if an expandable column does not display a twistie
Since:
Lotus Notes 6.5

isResortToView

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

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.

Since:
Lotus Notes 6.5

isSecondaryResort

boolean isSecondaryResort()
Indicates whether an ascending or descending user-sorted column has a secondary sorting column.

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 isSecondaryResortDescending() is true.

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

Since:
Lotus Notes 6.5

isSecondaryResortDescending

boolean isSecondaryResortDescending()
Indicates whether a secondary sorting column for a user-sorted column is sorted in descending order.

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

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

Since:
Lotus Notes 6.5

isCaseSensitiveSort

boolean isCaseSensitiveSort()
Indicates whether an auto-sorted column is sorted with regard to case.

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

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

Since:
Lotus Notes 6.5

isAccentSensitiveSort

boolean isAccentSensitiveSort()
Indicates whether an auto-sorted column is sorted with regard to accent.

Legal values

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

Usage

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

Since:
Lotus Notes 6.5

getHeaderFontColor

int getHeaderFontColor()
The font color of the header in a column.

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

Since:
Lotus Notes 6.5

getHeaderFontFace

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.

Returns:
font face of the header
Since:
Lotus Notes 6.5

getHeaderFontPointSize

int getHeaderFontPointSize()
The font point size of the header in a column.

Returns:
font point size
Since:
Lotus Notes 6.5

getHeaderFontStyle

int getHeaderFontStyle()
The font style of the header in a column.

Returns:
FONT_PLAIN, FONT_BOLD, FONT_ITALIC, FONT_UNDERLINE, FONT_STRIKEOUT, FONT_STRIKETHROUGH

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

Since:
Lotus Notes 6.5

getSecondaryResortColumnIndex

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.

Returns:
index of the secondary sorting column
Since:
Lotus Notes 6.5

isFontBold

boolean isFontBold()
Indicates whether the font style for a column includes bold.

Returns:
true if the font style includes bold, false if the font style does not include bold
Since:
Lotus Notes 6.5

isFontItalic

boolean isFontItalic()
Indicates whether the font style for a column includes italic.

Returns:
true if the font style includes italic, false if the font style does not include italic
Since:
Lotus Notes 6.5

isFontUnderline

boolean isFontUnderline()
Indicates whether the font style for a column includes underline.

Returns:
true if the font style includes underline, false if the font style does not include underline
Since:
Lotus Notes 6.5

isFontStrikethrough

boolean isFontStrikethrough()
Indicates whether the font style for a column includes strikethrough.

Returns:
true if the font style includes strikethrough, false if the font style does not include strikethrough
Since:
Lotus Notes 6.5

isHeaderFontBold

boolean isHeaderFontBold()
Indicates whether the header font style for a column includes bold.

Returns:
true if the header font style includes bold, false if the header font style does not include bold
Since:
Lotus Notes 6.5

isHeaderFontItalic

boolean isHeaderFontItalic()
Indicates whether the header font style for a column includes italic.

Returns:
true if the header font style includes italic, false if the header font style does not include italic
Since:
Lotus Notes 6.5

isHeaderFontUnderline

boolean isHeaderFontUnderline()
Indicates whether the header font style for a column includes underline.

Returns:
true if the header font style includes underline, false if the header font style does not include underline
Since:
Lotus Notes 6.5

isHeaderFontStrikethrough

boolean isHeaderFontStrikethrough()
Indicates whether the header font style for a column includes strikethrough.

Returns:
true if the header font style includes strikethrough, false if the header font style does not include strikethrough
Since:
Lotus Notes 6.5

isNumberAttribParens

boolean isNumberAttribParens()
Indicates whether the number attributes for a column include parentheses for negative numbers.

Returns:
true if the number attributes include parentheses, false if the number attributes do not include parentheses
Since:
Lotus Notes 6.5

isNumberAttribPunctuated

boolean isNumberAttribPunctuated()
Indicates whether the number attributes for a column include punctuation at thousandths.

Returns:
true if the number attributes include punctuation, false if the number attributes do not include punctuation
Since:
Lotus Notes 6.5

isNumberAttribPercent

boolean isNumberAttribPercent()
Indicates whether the number attributes for a column include displaying the number as a percentage.

Returns:
true if the number attributes include percent, false if the number attributes do not include percent
Since:
Lotus Notes 6.5

getResortToViewName

java.lang.String getResortToViewName()
The name of the target view for a user-sorted column that allows the user to change to another view.

Returns:
name of the target view
Since:
Lotus Notes 6.5

setDateFmt

void setDateFmt(int arg1)
The format of date data in a column.

Parameters:
arg1 - FMT_MD (month and day), FMT_YM (year and month), FMT_Y4M (4-digit year and month) or FMT_YMD (year, month, and day)
Since:
Lotus Notes 6.5

setFontColor

void setFontColor(int arg1)
The font color of data in a column.

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

Since:
Lotus Notes 6.5

setFontFace

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.

Parameters:
arg1 - font face of data
Since:
Lotus Notes 6.5

setFontPointSize

void setFontPointSize(int arg1)
The font point size of data in a column.

Parameters:
arg1 - font point size
Since:
Lotus Notes 6.5

setFontStyle

void setFontStyle(int arg1)
The font style of data in a column.

Parameters:
arg1 - FONT_PLAIN, FONT_BOLD, FONT_ITALIC FONT_UNDERLINE, FONT_STRIKEOUT or FONT_STRIKETHROUGH

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

Since:
Lotus Notes 6.5

setHeaderAlignment

void setHeaderAlignment(int arg1)
The alignment of the header in a column.

Parameters:
arg1 - ALIGN_CENTER, ALIGN_LEFT ALIGN_RIGHT
Since:
Lotus Notes 6.5

setAccentSensitiveSort

void setAccentSensitiveSort(boolean arg1)
Indicates whether an auto-sorted column is sorted with regard to accent.

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

Usage

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

Since:
Lotus Notes 6.5

setCaseSensitiveSort

void setCaseSensitiveSort(boolean arg1)
Indicates whether an auto-sorted column is sorted with regard to case.

Legal values

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

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

Since:
Lotus Notes 6.5

setHideDetail

void setHideDetail(boolean arg1)
Indicates whether the details for total columns are hidden.

Parameters:
arg1 - true if the details for totals are hidden, false if the details for totals are displayed
Since:
Lotus Notes 6.5

setResize

void setResize(boolean arg1)
Indicates whether a column is resizable.

Parameters:
arg1 - true if a column is resizable, false if a column is not resizable
Since:
Lotus Notes 6.5

setResortAscending

void setResortAscending(boolean arg1)
Indicates whether a column is a user-sorted column that can be sorted in ascending order.

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.

Since:
Lotus Notes 6.5

setResortDescending

void setResortDescending(boolean arg1)
Indicates whether a column is a user-sorted column that can be sorted in descending order.

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.

Since:
Lotus Notes 6.5

setResortToView

void setResortToView(boolean arg1)
Indicates whether a column is a user-sorted column that allows the user to change to another view.

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.

Since:
Lotus Notes 6.5

setSecondaryResort

void setSecondaryResort(boolean arg1)
Indicates whether an ascending or descending user-sorted column has a secondary sorting column.

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 isSecondaryResortDescending() is true.

Since:
Lotus Notes 6.5

setSecondaryResortDescending

void setSecondaryResortDescending(boolean arg1)
Indicates whether a secondary sorting column for a user-sorted column is sorted in descending order.

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

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

Since:
Lotus Notes 6.5

setShowTwistie

void setShowTwistie(boolean arg1)
Indicates whether an expandable column displays a twistie.

Parameters:
arg1 - true if an expandable column displays a twistie, false if an expandable column does not display a twistie
Since:
Lotus Notes 6.5

setSortDescending

void setSortDescending(boolean arg1)
Indicates whether an auto-sorted column is sorted in descending order.

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.

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

Since:
Lotus Notes 6.5

setSorted

void setSorted(boolean arg1)
Indicates whether a column is an auto-sorted column.

Legal values

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.

Since:
Lotus Notes 6.5

setListSep

void setListSep(int arg1)
List (multi-value) separator for values in a column.

Parameters:
arg1 - SEP_COMMA, SEP_NEWLINE, SEP_NONE, SEP_SEMICOLON or SEP_SPACE
Since:
Lotus Notes 6.5

setNumberAttrib

void setNumberAttrib(int arg1)
Attributes for numeric values in a column.

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

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

Since:
Lotus Notes 6.5

setNumberDigits

void setNumberDigits(int arg1)
Number of decimal places for numeric values in a column.

Parameters:
arg1 - number of decimal places
Since:
Lotus Notes 6.5

setNumberFormat

void setNumberFormat(int arg1)
Format for numeric values in a column.

Parameters:
arg1 - FMT_CURRENCY, FMT_FIXED FMT_GENERAL or FMT_SCIENTIFIC
Since:
Lotus Notes 6.5

setTimeDateFmt

void setTimeDateFmt(int arg1)
The format of time-date data in a column.

Parameters:
arg1 - FMT_DATE (Date only), FMT_DATETIME (Date and time), FMT_TIME (Time only), FMT_TODAYTIME (Date or 'Today' or 'Yesterday' -- and time)
Since:
Lotus Notes 6.5

setTimeFmt

void setTimeFmt(int arg1)
The format of time data in a column.

Parameters:
arg1 - FMT_HM (hour and minute), FMT_HMS (hour, minute, and second), FMT_H (hour only) FMT_ALL (hour, minute, second, and hundredths of a second)
Since:
Lotus Notes 6.5

setTimeZoneFmt

void setTimeZoneFmt(int arg1)
The format of the zone in a time-date column value.

Parameters:
arg1 - FMT_ALWAYS (always show time zone), FMT_NEVER (never show time zone) or FMT_SOMETIMES (show time zone if the time is not local)
Since:
Lotus Notes 6.5

setWidth

void setWidth(int arg1)
The width of a column.

Parameters:
arg1 - width of column
Since:
Lotus Notes 6.5

setHeaderFontColor

void setHeaderFontColor(int arg1)
The font color of the header in a column.

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

Since:
Lotus Notes 6.5

setHeaderFontFace

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.

Parameters:
arg1 - font face of header
Since:
Lotus Notes 6.5

setHeaderFontPointSize

void setHeaderFontPointSize(int arg1)
The font point size of the header in a column.

Parameters:
arg1 - font point size of the header
Since:
Lotus Notes 6.5

setHeaderFontStyle

void setHeaderFontStyle(int arg1)
The font style of the header in a column.

Parameters:
arg1 - FONT_PLAIN, FONT_BOLD
  • #FONT_ITALIC}, FONT_UNDERLINE
  • #FONT_STRIKEOUT} or FONT_STRIKETHROUGH

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

    Since:
    Lotus Notes 6.5

  • setSecondaryResortColumnIndex

    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.

    Parameters:
    arg1 - index of the secondary sorting column
    Since:
    Lotus Notes 6.5

    setFontBold

    void setFontBold(boolean arg1)
    Indicates whether the font style for a column includes bold.

    Parameters:
    arg1 - true if the font style includes bold, false if the font style does not include bold
    Since:
    Lotus Notes 6.5

    setFontItalic

    void setFontItalic(boolean arg1)
    Indicates whether the font style for a column includes italic.

    Parameters:
    arg1 - true if the font style includes italic, false if the font style does not include italic
    Since:
    Lotus Notes 6.5

    setFontUnderline

    void setFontUnderline(boolean arg1)
    Indicates whether the font style for a column includes underline.

    Parameters:
    arg1 - true if the font style includes underline, false if the font style does not include underline
    Since:
    Lotus Notes 6.5

    setFontStrikethrough

    void setFontStrikethrough(boolean arg1)
    Indicates whether the font style for a column includes strikethrough.

    Parameters:
    arg1 - true if the font style includes strikethrough, false if the font style does not include strikethrough
    Since:
    Lotus Notes 6.5

    setHeaderFontBold

    void setHeaderFontBold(boolean arg1)
    Indicates whether the header font style for a column includes bold.

    Parameters:
    arg1 - true if the header font style includes bold, false if the header font style does not include bold
    Since:
    Lotus Notes 6.5

    setHeaderFontItalic

    void setHeaderFontItalic(boolean arg1)
    Indicates whether the header font style for a column includes italic.

    Parameters:
    arg1 - true if the header font style includes italic, false if the header font style does not include italic
    Since:
    Lotus Notes 6.5

    setHeaderFontUnderline

    void setHeaderFontUnderline(boolean arg1)
    Indicates whether the header font style for a column includes underline.

    Parameters:
    arg1 - true if the header font style includes underline, false if the header font style does not include underline
    Since:
    Lotus Notes 6.5

    setHeaderFontStrikethrough

    void setHeaderFontStrikethrough(boolean arg1)
    Indicates whether the header font style for a column includes strikethrough.

    Parameters:
    arg1 - true if the header font style includes strikethrough, false if the header font style does not include strikethrough
    Since:
    Lotus Notes 6.5

    setNumberAttribParens

    void setNumberAttribParens(boolean arg1)
    Indicates whether the number attributes for a column include parentheses for negative numbers.

    Parameters:
    arg1 - true if the number attributes include parentheses, false if the number attributes do not include parentheses
    Since:
    Lotus Notes 6.5

    setNumberAttribPunctuated

    void setNumberAttribPunctuated(boolean arg1)
    Indicates whether the number attributes for a column include punctuation at thousandths.

    Parameters:
    arg1 - true if the number attributes include punctuation, false if the number attributes do not include punctuation
    Since:
    Lotus Notes 6.5

    setNumberAttribPercent

    void setNumberAttribPercent(boolean arg1)
    Indicates whether the number attributes for a column include displaying the number as a percentage.

    Parameters:
    arg1 - true if the number attributes include percent, false if the number attributes do not include percent
    Since:
    Lotus Notes 6.5

    setResortToViewName

    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.

    Parameters:
    arg1 - name of target view
    Since:
    Lotus Notes 6.5


    Domingo Java-API