Enterprise Information Portal APIs

com.ibm.mm.beans
Class CMBViewData

java.lang.Object
  |
  +--com.ibm.mm.beans.CMBViewData
All Implemented Interfaces:
java.io.Serializable

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

This is the helper class for the CMBDataManagement bean. This class provides functions for manipulation of logical view data for documents. This class should be used for OnDemand documents only.

Since:
6.1
See Also:
CMBDataManagement, Serialized Form

Field Summary
static char CMB_VIEWDATA_COLOR_BLACK
           
static char CMB_VIEWDATA_COLOR_BLUE
           
static char CMB_VIEWDATA_COLOR_CYAN
           
static char CMB_VIEWDATA_COLOR_DEFAULT
           
static char CMB_VIEWDATA_COLOR_GREEN
           
static char CMB_VIEWDATA_COLOR_GREEN_BAR
           
static char CMB_VIEWDATA_COLOR_GREY
           
static char CMB_VIEWDATA_COLOR_MAGENTA
           
static char CMB_VIEWDATA_COLOR_NONE
           
static char CMB_VIEWDATA_COLOR_RED
           
static char CMB_VIEWDATA_COLOR_WHITE
           
static char CMB_VIEWDATA_COLOR_YELLOW
           
static char CMB_VIEWDATA_IMAGE_INTENSITY_LIGHT
           
static char CMB_VIEWDATA_IMAGE_INTENSITY_NONE
           
static char CMB_VIEWDATA_IMAGE_INTENSITY_NORMAL
           
static char CMB_VIEWDATA_TEXT_FIDELITY_240
           
static char CMB_VIEWDATA_TEXT_FIDELITY_CHAR
           
static char CMB_VIEWDATA_TEXT_FIDELITY_DRAFT
           
static char CMB_VIEWDATA_TEXT_FIDELITY_LINE
           
static char CMB_VIEWDATA_TEXT_FIDELITY_WORD
           
 
Constructor Summary
CMBViewData()
          Default constructor
CMBViewData(java.lang.String name)
          Constructs a new CMBViewData with a name
 
Method Summary
 java.awt.Color getBackgroundColor()
          Gets background color
 int getBrightness()
          Returns the brightness value for this view
 byte[] getByteArrayData()
          Gets view data in byte array format.
 int getContrast()
          Returns the contrast value for this view
 int getCopyGroup()
          Returns the copy group attribute for this view
 char getGrayscale()
          Returns the grayscale value for this view
 java.awt.Color getImageColor()
          Gets image color
 char getImageIntensity()
          Gets image intensity
 int getLDFieldArraySize()
          Returns display order array size
 int[] getLDFieldDisplayOrders()
          Returns the line data field display order
 java.lang.String getName()
          Gets the view data name
 int getNumLDFieldDisplayOrders()
          Returns the number of line data field display orders
 int getNumLockedFields()
          Returns the number of locked fields
 java.awt.Color getSelectedAreaColor()
          Gets selected area color
 char getTextFidelity()
          Gets text fidelity
 int getZoomPercentage()
          Gets zoom percentage
 boolean isLockHeaderRows()
          Returns whether or not to lock header rows for this view
 boolean isViewPublic()
          Gets if everyone could view data.
 void setBackgroundColor(java.awt.Color backgroundColor)
          Sets background color
 void setBrightness(int brightness)
          Sets the brightness value of this view
 void setByteArrayData(byte[] data)
          Sets view data in byte array format.
 void setContrast(int contrast)
          Sets the contrast value of this view
 void setCopyGroup(int copygroup)
          Sets the copy group attribute of this view
 void setGrayscale(char grayscale)
          Sets the grayscale value of this view
 void setImageColor(java.awt.Color imageColor)
          Sets image color
 void setImageIntensity(char imageIntensity)
          Sets image intensity
 void setLockHeaderRows(boolean v)
          Sets whether or not to lock header rows for this view
 void setName(java.lang.String name)
          Sets the view data name
 void setNumLDFieldDisplayOrders(int n)
          Sets the number of line data field display orders
 void setNumLockedFields(int n)
          Sets the number of locked fields
 void setSelectedAreadColor(java.awt.Color selectedAreaColor)
          Sets selected area color
 void setTextFidelity(char textFidelity)
          Sets text fidelity
 void setViewPublic(boolean viewPublic)
          Sets the view data public.
 void setZoomPercentage(int zoomPercentage)
          Sets zoom percentage
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CMB_VIEWDATA_IMAGE_INTENSITY_NORMAL

public static final char CMB_VIEWDATA_IMAGE_INTENSITY_NORMAL

CMB_VIEWDATA_IMAGE_INTENSITY_LIGHT

public static final char CMB_VIEWDATA_IMAGE_INTENSITY_LIGHT

CMB_VIEWDATA_IMAGE_INTENSITY_NONE

public static final char CMB_VIEWDATA_IMAGE_INTENSITY_NONE

CMB_VIEWDATA_TEXT_FIDELITY_LINE

public static final char CMB_VIEWDATA_TEXT_FIDELITY_LINE

CMB_VIEWDATA_TEXT_FIDELITY_WORD

public static final char CMB_VIEWDATA_TEXT_FIDELITY_WORD

CMB_VIEWDATA_TEXT_FIDELITY_CHAR

public static final char CMB_VIEWDATA_TEXT_FIDELITY_CHAR

CMB_VIEWDATA_TEXT_FIDELITY_DRAFT

public static final char CMB_VIEWDATA_TEXT_FIDELITY_DRAFT

CMB_VIEWDATA_TEXT_FIDELITY_240

public static final char CMB_VIEWDATA_TEXT_FIDELITY_240

CMB_VIEWDATA_COLOR_WHITE

public static final char CMB_VIEWDATA_COLOR_WHITE

CMB_VIEWDATA_COLOR_BLACK

public static final char CMB_VIEWDATA_COLOR_BLACK

CMB_VIEWDATA_COLOR_RED

public static final char CMB_VIEWDATA_COLOR_RED

CMB_VIEWDATA_COLOR_BLUE

public static final char CMB_VIEWDATA_COLOR_BLUE

CMB_VIEWDATA_COLOR_GREEN

public static final char CMB_VIEWDATA_COLOR_GREEN

CMB_VIEWDATA_COLOR_YELLOW

public static final char CMB_VIEWDATA_COLOR_YELLOW

CMB_VIEWDATA_COLOR_MAGENTA

public static final char CMB_VIEWDATA_COLOR_MAGENTA

CMB_VIEWDATA_COLOR_CYAN

public static final char CMB_VIEWDATA_COLOR_CYAN

CMB_VIEWDATA_COLOR_GREY

public static final char CMB_VIEWDATA_COLOR_GREY

CMB_VIEWDATA_COLOR_GREEN_BAR

public static final char CMB_VIEWDATA_COLOR_GREEN_BAR

CMB_VIEWDATA_COLOR_DEFAULT

public static final char CMB_VIEWDATA_COLOR_DEFAULT

CMB_VIEWDATA_COLOR_NONE

public static final char CMB_VIEWDATA_COLOR_NONE
Constructor Detail

CMBViewData

public CMBViewData()
Default constructor

CMBViewData

public CMBViewData(java.lang.String name)
Constructs a new CMBViewData with a name
Parameters:
name - view data name
Method Detail

getName

public java.lang.String getName()
Gets the view data name
Returns:
view data name

setName

public void setName(java.lang.String name)
Sets the view data name
Parameters:
name - view data name

isViewPublic

public boolean isViewPublic()
Gets if everyone could view data.
Returns:
viewpublic

setViewPublic

public void setViewPublic(boolean viewPublic)
Sets the view data public. If true then everyone could view the data
Parameters:
viewPublic - true if publicly viewable, false otherwise

getZoomPercentage

public int getZoomPercentage()
Gets zoom percentage
Returns:
zoom percentage

setZoomPercentage

public void setZoomPercentage(int zoomPercentage)
Sets zoom percentage
Parameters:
zoomPercentage - zoom percentage

getCopyGroup

public int getCopyGroup()
Returns the copy group attribute for this view
Returns:
copygroup attribute

setCopyGroup

public void setCopyGroup(int copygroup)
Sets the copy group attribute of this view
Parameters:
copygroup -  

getContrast

public int getContrast()
Returns the contrast value for this view
Returns:
contrast attribute

setContrast

public void setContrast(int contrast)
Sets the contrast value of this view
Parameters:
contrast -  

getBrightness

public int getBrightness()
Returns the brightness value for this view
Returns:
brightness attribute

setBrightness

public void setBrightness(int brightness)
Sets the brightness value of this view
Parameters:
brightness -  

getGrayscale

public char getGrayscale()
Returns the grayscale value for this view
Returns:
grayscale attribute

setGrayscale

public void setGrayscale(char grayscale)
Sets the grayscale value of this view
Parameters:
grayscale -  

getBackgroundColor

public java.awt.Color getBackgroundColor()
Gets background color
Returns:
background color

setBackgroundColor

public void setBackgroundColor(java.awt.Color backgroundColor)
Sets background color
Parameters:
background - color

getSelectedAreaColor

public java.awt.Color getSelectedAreaColor()
Gets selected area color
Returns:
selected area color

setSelectedAreadColor

public void setSelectedAreadColor(java.awt.Color selectedAreaColor)
Sets selected area color
Parameters:
selected - area color

getImageColor

public java.awt.Color getImageColor()
Gets image color
Returns:
image color

setImageColor

public void setImageColor(java.awt.Color imageColor)
Sets image color
Parameters:
imageColor - image color

getImageIntensity

public char getImageIntensity()
Gets image intensity
Returns:
image intensity

setImageIntensity

public void setImageIntensity(char imageIntensity)
Sets image intensity
Parameters:
imageIntensity - intensity

getTextFidelity

public char getTextFidelity()
Gets text fidelity
Returns:
text fidelity

setTextFidelity

public void setTextFidelity(char textFidelity)
Sets text fidelity
Parameters:
textFidelity - text fidelity

setLockHeaderRows

public void setLockHeaderRows(boolean v)
Sets whether or not to lock header rows for this view
Parameters:
v -  

isLockHeaderRows

public boolean isLockHeaderRows()
Returns whether or not to lock header rows for this view
Returns:
lockheaderrows attribute

setNumLockedFields

public void setNumLockedFields(int n)
Sets the number of locked fields
Parameters:
n -  

getNumLockedFields

public int getNumLockedFields()
Returns the number of locked fields
Returns:
int

setNumLDFieldDisplayOrders

public void setNumLDFieldDisplayOrders(int n)
Sets the number of line data field display orders
Parameters:
n -  

getNumLDFieldDisplayOrders

public int getNumLDFieldDisplayOrders()
Returns the number of line data field display orders
Returns:
int

getLDFieldArraySize

public int getLDFieldArraySize()
Returns display order array size
Returns:
int

getLDFieldDisplayOrders

public int[] getLDFieldDisplayOrders()
Returns the line data field display order
Returns:
int[]

getByteArrayData

public byte[] getByteArrayData()
Gets view data in byte array format.
Returns:
array view data

setByteArrayData

public void setByteArrayData(byte[] data)
Sets view data in byte array format.
Parameters:
array - view data

EIP JavaBeans

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.