Style Intelligence v12.0

inetsoft.report.lens
Class AttributeFormLens

java.lang.Object
  extended by inetsoft.report.lens.AttributeFormLens
All Implemented Interfaces:
FormLens, StyleConstants, XConstants, Serializable, Cloneable
Direct Known Subclasses:
DefaultFormLens, XNodeFormLens

public class AttributeFormLens
extends Object
implements FormLens

AttributeFormLens is a form lens decorator. It supports setting of form attribute values.

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface inetsoft.report.StyleConstants
ARROW_LINE_1, ARROW_LINE_2, ARROW_LINE_3, BACKGROUND_CENTER, BACKGROUND_TILED, BOX_RECTANGLE, BOX_ROUNDED_RECTANGLE, CENTER, CHART_3D_BAR, CHART_3D_BAR_3D, CHART_3D_PIE, CHART_3D_STACK_BAR, CHART_AREA, CHART_BAR, CHART_BUBBLE, CHART_CANDLE, CHART_CURVE, CHART_FILL_RADAR, CHART_GANTT, CHART_INV_BAR, CHART_INV_CURVE, CHART_INV_LINE, CHART_INV_POINT, CHART_INV_STACK_BAR, CHART_LINE, CHART_MAX_USER, CHART_PARETO, CHART_PIE, CHART_PIE_EXPLODED_ALL, CHART_PIE_EXPLODED_FIRST, CHART_PIE_EXPLODED_NONE, CHART_POINT, CHART_RADAR, CHART_RIBBON, CHART_SCATTER, CHART_SPEEDOMETER, CHART_STACK_AREA, CHART_STACK_BAR, CHART_STICK, CHART_STOCK, CHART_SURFACE, CHART_USER, CHART_VOLUME, CHART_WATERFALL, CHART_XY_LINE, CIRCLE, CROSS, CURRENCY, DASH_LINE, DASH_MASK, DEFAULT_PAGE_SIZE, DIAMOND, DOT_LINE, DOUBLE_3D_LOWERED, DOUBLE_3D_RAISED, DOUBLE_LINE, DOUBLE_MASK, FILL, FILLED_CIRCLE, FILLED_DIAMOND, FILLED_SQUARE, FILLED_TRIANGLE, FRACTION_WIDTH_MASK, H_ALIGN_MASK, H_CENTER, H_CURRENCY, H_LEFT, H_LINE, H_RIGHT, LANDSCAPE, LARGE_DASH, LEFT, LINECAP_BUTT, LINECAP_ROUND, LINECAP_SQUARE, LINEJOIN_BEVEL, LINEJOIN_MITER, LINEJOIN_ROUND, LOWERED_3D, LOWERED_MASK, LT_ANGLE, MEDIUM_DASH, MEDIUM_LINE, NIL, NO_BORDER, NONE, PAPER_10X11, PAPER_10X14, PAPER_11X17, PAPER_15X11, PAPER_9X11, PAPER_A_PLUS, PAPER_A2, PAPER_A3, PAPER_A3_EXTRA, PAPER_A3_EXTRA_TRANSVERSE, PAPER_A3_TRANSVERSE, PAPER_A4, PAPER_A4_EXTRA, PAPER_A4_PLUS, PAPER_A4_TRANSVERSE, PAPER_A4SMALL, PAPER_A5, PAPER_A5_EXTRA, PAPER_A5_TRANSVERSE, PAPER_B_PLUS, PAPER_B4, PAPER_B5, PAPER_B5_EXTRA, PAPER_B5_TRANSVERSE, PAPER_CSHEET, PAPER_DSHEET, PAPER_ENV_10, PAPER_ENV_11, PAPER_ENV_12, PAPER_ENV_14, PAPER_ENV_9, PAPER_ENV_B4, PAPER_ENV_B5, PAPER_ENV_B6, PAPER_ENV_C3, PAPER_ENV_C4, PAPER_ENV_C5, PAPER_ENV_C6, PAPER_ENV_C65, PAPER_ENV_DL, PAPER_ENV_INVITE, PAPER_ENV_ITALY, PAPER_ENV_MONARCH, PAPER_ENV_PERSONAL, PAPER_ESHEET, PAPER_EXECUTIVE, PAPER_FANFOLD_LGL_GERMAN, PAPER_FANFOLD_STD_GERMAN, PAPER_FANFOLD_US, PAPER_FOLIO, PAPER_ISO_B4, PAPER_JAPANESE_POSTCARD, PAPER_LEDGER, PAPER_LEGAL, PAPER_LEGAL_EXTRA, PAPER_LETTER, PAPER_LETTER_EXTRA, PAPER_LETTER_EXTRA_TRANSVERSE, PAPER_LETTER_PLUS, PAPER_LETTER_TRANSVERSE, PAPER_LETTERSMALL, PAPER_NOTE, PAPER_QUARTO, PAPER_STATEMENT, PAPER_TABLOID, PAPER_TABLOID_EXTRA, PATTERN_0, PATTERN_1, PATTERN_10, PATTERN_11, PATTERN_12, PATTERN_13, PATTERN_14, PATTERN_15, PATTERN_16, PATTERN_17, PATTERN_18, PATTERN_19, PATTERN_2, PATTERN_3, PATTERN_4, PATTERN_5, PATTERN_6, PATTERN_7, PATTERN_8, PATTERN_9, PATTERN_NONE, PORTRAIT, RAISED_3D, RAISED_MASK, REMAINDER, RIGHT, RIGHT_ANGLE, SOLID_MASK, SQUARE, STAR, THICK_LINE, THIN_LINE, THIN_THIN_LINE, TRAY_AUTO, TRAY_CASSETTE, TRAY_ENVELOPE, TRAY_ENVMANUAL, TRAY_FORMSOURCE, TRAY_LARGECAPACITY, TRAY_LARGEFMT, TRAY_LOWER, TRAY_MANUAL, TRAY_MIDDLE, TRAY_ONLYONE, TRAY_SMALLFMT, TRAY_TRACTOR, TRAY_UPPER, TRIANGLE, ULTRA_THIN_LINE, V_ALIGN_MASK, V_ANGLE, V_BASELINE, V_BOTTOM, V_CENTER, V_LINE, V_TOP, WIDTH_MASK, X
 
Fields inherited from interface inetsoft.uql.XConstants
AM_PM_DATE_GROUP, AM_PM_OF_DAY_DATE_GROUP, AVERAGE_FORMULA, CALC_FORMULA, COLUMN, CONCAT_FORMULA, CONDITION_EMPTY_STRING, CONDITION_NULL_STRING, CONDITION_NULL_VALUE, CONDITION_REAL_NULL, CORRELATION_FORMULA, COUNT_FORMULA, COVARIANCE_FORMULA, CURRENCY_FORMAT, CURRENT_REP_CHANGED, CURRENT_REP_WILL_CHANGE, DATE_FORMAT, DAY_DATE_GROUP, DAY_OF_MONTH_DATE_GROUP, DAY_OF_WEEK_DATE_GROUP, DAY_OF_YEAR_DATE_GROUP, DECIMAL_FORMAT, DISTINCTCOUNT_FORMULA, FIRST_FORMULA, FULL_JOIN, GREATER_EQUAL_JOIN, GREATER_JOIN, GROUP_OTHERS, HOUR_DATE_GROUP, HOUR_OF_DAY_DATE_GROUP, INNER_JOIN, JOIN, LAST_FORMULA, LEAVE_OTHERS, LEFT_JOIN, LESS_EQUAL_JOIN, LESS_JOIN, MAX_FORMULA, MEDIAN_FORMULA, MESSAGE_FORMAT, MILLISECOND_DATE_GROUP, MIN_FORMULA, MINUTE_DATE_GROUP, MODE_FORMULA, MONTH_DATE_GROUP, MONTH_OF_YEAR_DATE_GROUP, NONE_DATE_GROUP, NONE_FORMULA, NOT_EQUAL_JOIN, NTHLARGEST_FORMULA, NTHMOSTFREQUENT_FORMULA, NTHSMALLEST_FORMULA, PARAM_PREFIX, PART_DATE_GROUP, PERCENT_FORMAT, PERCENTAGE_BY_COL, PERCENTAGE_BY_ROW, PERCENTAGE_NONE, PERCENTAGE_OF_COL_GRANDTOTAL, PERCENTAGE_OF_COL_GROUP, PERCENTAGE_OF_GRANDTOTAL, PERCENTAGE_OF_GROUP, PERCENTAGE_OF_ROW_GRANDTOTAL, PERCENTAGE_OF_ROW_GROUP, POPULATIONSTANDARDDEVIATION_FORMULA, POPULATIONVARIANCE_FORMULA, PRODUCT_FORMULA, PTHPERCENTILE_FORMULA, QUARTER_DATE_GROUP, QUARTER_OF_YEAR_DATE_GROUP, RIGHT_JOIN, SECOND_DATE_GROUP, SET_FORMULA, SORT_ASC, SORT_DESC, SORT_NONE, SORT_ORIGINAL, SORT_SPECIFIC, SORT_VALUE_ASC, SORT_VALUE_DESC, STANDARDDEVIATION_FORMULA, SUB_QUERY_PARAM, SUM_FORMULA, SUMSQ_FORMULA, SUMWT_FORMULA, VARIANCE_FORMULA, WEEK_DATE_GROUP, WEEK_OF_MONTH_DATE_GROUP, WEEK_OF_YEAR_DATE_GROUP, WEIGHTEDAVERAGE_FORMULA, YEAR_DATE_GROUP
 
Constructor Summary
AttributeFormLens()
          Create an empty attribute form lens.
AttributeFormLens(FormLens form)
          Create a decorator for form.
 
Method Summary
 Object clone()
           
 Color getBackground(int f)
          Return the background color to print the field value.
 Object getField(int f)
          Return the value of the specified field.
 int getFieldCount()
          Return the number of fields in the form.
 int getFieldPerRow()
          Return the number of fields in a row.
 Font getFont(int f)
          Return the font used to print the field value.
 Color getForeground(int f)
          Return the foreground color to print the field value.
 FormLens getForm()
          Get the base form of this attribute form lens.
 Object getLabel(int f)
          Get the label of the specified field.
 Color getLabelBackground(int f)
          Return the background color to print the field label.
 Font getLabelFont(int f)
          Return the font used to print the field label.
 Color getLabelForeground(int f)
          Return the foreground color to print the field label.
 int getUnderline()
          Get the underline of the fields.
 int getWidth(int col)
          Get the width of a column.
 void setBackground(Color bg)
          Set field value background.
 void setFieldPerRow(int per)
          Set the number of fields per row.
 void setFont(Font font)
          Set the field value font.
 void setForeground(Color fg)
          Set the field value foreground.
 void setForm(FormLens form)
          Set the base form of this attribute form lens.
 void setLabelBackground(Color bg)
          Set the label text background.
 void setLabelFont(Font labelFont)
          Set the label font.
 void setLabelForeground(Color fg)
          Set the label text foreground.
 void setUnderline(int line)
          Set the field underline line style.
 void setWidth(int col, int w)
          Set the column width.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AttributeFormLens

public AttributeFormLens()
Create an empty attribute form lens. The setForm() method must be called before this object is used.


AttributeFormLens

public AttributeFormLens(FormLens form)
Create a decorator for form.

Parameters:
form - base form.
Method Detail

setForm

public void setForm(FormLens form)
Set the base form of this attribute form lens.

Parameters:
form - base form.

getForm

public FormLens getForm()
Get the base form of this attribute form lens.

Returns:
base form.

getFieldCount

public int getFieldCount()
Return the number of fields in the form.

Specified by:
getFieldCount in interface FormLens
Returns:
number of fields in the form.

getField

public Object getField(int f)
Return the value of the specified field.

Specified by:
getField in interface FormLens
Parameters:
f - field number.
Returns:
the value of the field.

getLabel

public Object getLabel(int f)
Get the label of the specified field.

Specified by:
getLabel in interface FormLens
Parameters:
f - field number.

getFieldPerRow

public int getFieldPerRow()
Return the number of fields in a row. One field consists of a field label and a field value.

Specified by:
getFieldPerRow in interface FormLens
Returns:
number of fields per row.

setFieldPerRow

public void setFieldPerRow(int per)
Set the number of fields per row.

Parameters:
per - number of fields per row.

getWidth

public int getWidth(int col)
Get the width of a column. The column index is different from the field index. One field consists of two columns, a field label and the field value itself.

Specified by:
getWidth in interface FormLens

setWidth

public void setWidth(int col,
                     int w)
Set the column width.

Parameters:
col - column number.
w - column width.

getLabelFont

public Font getLabelFont(int f)
Return the font used to print the field label.

Specified by:
getLabelFont in interface FormLens
Parameters:
f - field number.
Returns:
font for the specified field label.

setLabelFont

public void setLabelFont(Font labelFont)
Set the label font.

Parameters:
labelFont - font.

getLabelForeground

public Color getLabelForeground(int f)
Return the foreground color to print the field label.

Specified by:
getLabelForeground in interface FormLens
Parameters:
f - field number.
Returns:
foreground color for the specified field labe.

setLabelForeground

public void setLabelForeground(Color fg)
Set the label text foreground.

Parameters:
fg - foreground color.

getLabelBackground

public Color getLabelBackground(int f)
Return the background color to print the field label.

Specified by:
getLabelBackground in interface FormLens
Parameters:
f - field number.
Returns:
background color for the specified field label.

setLabelBackground

public void setLabelBackground(Color bg)
Set the label text background.

Parameters:
bg - background color.

getFont

public Font getFont(int f)
Return the font used to print the field value.

Specified by:
getFont in interface FormLens
Parameters:
f - field number.
Returns:
font for the specified field.

setFont

public void setFont(Font font)
Set the field value font.

Parameters:
font - field font.

getForeground

public Color getForeground(int f)
Return the foreground color to print the field value.

Specified by:
getForeground in interface FormLens
Parameters:
f - field number.
Returns:
foreground color for the specified field.

setForeground

public void setForeground(Color fg)
Set the field value foreground.

Parameters:
fg - foreground color.

getBackground

public Color getBackground(int f)
Return the background color to print the field value.

Specified by:
getBackground in interface FormLens
Parameters:
f - field number.
Returns:
background color for the specified field.

setBackground

public void setBackground(Color bg)
Set field value background.

Parameters:
bg - background color.

getUnderline

public int getUnderline()
Get the underline of the fields. To disable underline, return StyleConstants.NONE.

Specified by:
getUnderline in interface FormLens
Returns:
underline line type.

setUnderline

public void setUnderline(int line)
Set the field underline line style.

Parameters:
line - line style.

clone

public Object clone()
             throws CloneNotSupportedException
Overrides:
clone in class Object
Throws:
CloneNotSupportedException

Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.