com.ibm.edms.od

Class ODLogicalView

java.lang.Object

com.ibm.edms.od.ODLogicalView

All Implemented Interfaces:

java.io.Serializable

public class ODLogicalView
extends java.lang.Object
implements java.io.Serializable

A class representing an OnDemand Logical View. From this class you can gather logical view information such as the number of Header Rows, Locked Fields, and Zoom. For more information about an OnDemand Logical View, please refer to the OnDemand Administrative GUI on-line help.

A typical usage of ODLogicalView is based upon first having a valid ODHit object. From ODHit, you may query for the names of all associated logical views. Then, based on a valid logical view name, you may retrieve the logical view object:

      ...
      String [] logicalViews = myODHit.getLogicalViewNames();
      ODLogicalView myView = myODHit.getLogicalView(logicalViews[0]);
      ...
 

WARNING: It is required that access to all ODWEK objects only be done in a single threaded environment.

(c) Copyright IBM Corp. 1993, 2015. All Rights Reserved

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
char	getBackgroundColor() Get the backgroundColor.
int	getBrightness() Get the brightness
int	getContrast() Get the contrast
int	getCopyGroup() Get the copy group
char	getGrayscale() Get the gray scale
char	getHeadingColor() Get the heading color
char	getImageColor() Get the image color
char	getImageIntensity() Get the image intensity
int[]	getLdFieldDisplayOrder() Get the order in which the fields will be displayed
java.lang.String	getName() Get the name of this logical view
int	getNumLDDisplayFields() Get the number of fields in the display order
int	getNumLockedFields() Get the number of locked fields
char	getOverstrike() Get the overstrike
char	getSelectedAreaColor() Get the selected area color
char	getTextFidelity() Get the text fidelity
int	getZoom() Get the zoom percentage.
boolean	hasLockHeaderRows() Determine if header rows should be locked
boolean	isPublic() Determine if this logical view is public

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getBackgroundColor

public char getBackgroundColor()

Get the backgroundColor.

Returns:

Returns the backgroundColor.

getBrightness

public int getBrightness()

Get the brightness

Returns:

Returns the brightness.

getContrast

public int getContrast()

Get the contrast

Returns:

Returns the contrast.

getCopyGroup

public int getCopyGroup()

Get the copy group

Returns:

Returns the copyGroup.

getGrayscale

public char getGrayscale()

Get the gray scale

Returns:

Returns the grayscale.

See Also:

ODConstant.OD_GRAYSCALE_SCALE, ODConstant.OD_GRAYSCALE_COLOR

getHeadingColor

public char getHeadingColor()

Get the heading color

Returns:

Returns the headingColor.

See Also:

ODConstant.ColorWhite, ODConstant.ColorBlack, ODConstant.ColorRed, ODConstant.ColorBlue, ODConstant.ColorGreen, ODConstant.ColorYellow, ODConstant.ColorGrey, ODConstant.ColorDefault

getImageColor

public char getImageColor()

Get the image color

Returns:

Returns the imageColor.

See Also:

ODConstant.ColorWhite, ODConstant.ColorBlack, ODConstant.ColorRed, ODConstant.ColorBlue, ODConstant.ColorGreen, ODConstant.ColorYellow, ODConstant.ColorMagenta, ODConstant.ColorCyan, ODConstant.ColorGrey, ODConstant.ColorGreenBar, ODConstant.ColorDefault, ODConstant.ColorNone

getImageIntensity

public char getImageIntensity()

Get the image intensity

Returns:

Returns the imageIntensity.

See Also:

ODConstant.OD_IMAGE_INTENSITY_NORMAL, ODConstant.OD_IMAGE_INTENSITY_LIGHT, ODConstant.OD_IMAGE_INTENSITY_NONE

getLdFieldDisplayOrder

public int[] getLdFieldDisplayOrder()

Get the order in which the fields will be displayed

Returns:

Returns the ldFieldDisplayOrders.

hasLockHeaderRows

public boolean hasLockHeaderRows()

Determine if header rows should be locked

Returns:

Boolean true if view contains locked header rows.

getName

public java.lang.String getName()

Get the name of this logical view

Returns:

Returns the name of this logical view.

getNumLDDisplayFields

public int getNumLDDisplayFields()

Get the number of fields in the display order

Returns:

Returns the numLDFieldDisplayOrders.

getNumLockedFields

public int getNumLockedFields()

Get the number of locked fields

Returns:

Returns the numLockedFields.

getOverstrike

public char getOverstrike()

Get the overstrike

Returns:

Returns the overstrike.

See Also:

ODConstant.OD_OVERSTRIKE_SEPARATE, ODConstant.OD_OVERSTRIKE_MERGE, ODConstant.OD_OVERSTRIKE_FULL

isPublic

public boolean isPublic()

Determine if this logical view is public

Returns:

Returns true if the logical view is public else false

getSelectedAreaColor

public char getSelectedAreaColor()

Get the selected area color

Returns:

Returns the selectedAreaColor.

getTextFidelity

public char getTextFidelity()

Get the text fidelity

Returns:

Returns the textFidelity.

See Also:

ODConstant.OD_TEXT_FIDELITY_LINE, ODConstant.OD_TEXT_FIDELITY_WORD, ODConstant.OD_TEXT_FIDELITY_CHAR, ODConstant.OD_TEXT_FIDELITY_DRAFT, ODConstant.OD_TEXT_FIDELITY_240

getZoom

public int getZoom()

Get the zoom percentage.
For Example: 100 would mean zoom 100 percent.

Returns:

Returns the zoom percentage.