Style Intelligence v12.0

inetsoft.report
Interface TextBoxElement

All Superinterfaces:
Cloneable, HyperlinkSupport, PainterElement, ReportElement, Serializable

public interface TextBoxElement
extends PainterElement

A TextBox is a rectangular area for printing text contents. It is a painter element. This means it can be anchored and resized. Another main difference between a text box and a text element is that textbox does not flow around other elements, or flow across pages. It is normally used to present small amount of text when text position needs to be controlled.


Field Summary
 
Fields inherited from interface inetsoft.report.ReportElement
AGGREGATE, AUTOSIZE, GROW, LOCAL_QUERY, QUERY, XNODEPATH
 
Method Summary
 int getBorder()
          Get the border around this text box.
 Color getBorderColor()
          Get the border color.
 Insets getBorders()
          Get the individual border line styles.
 Dimension getCornerSize()
          Get the corner width and height of rounded rectangle.
 Object getData()
          Get the data in object, it's used for binding.
 Insets getPadding()
          Get box padding space.
 int getShape()
          Get the textbox shape.
 String getText()
          Return the text in the text lens.
 int getTextAlignment()
          Get the text alignment.
 String getTextID()
          Get the textID, which is used for i18n support.
 TextLens getTextLens()
          Return the text lens of this text element.
 boolean isJustify()
          Get the line justify setting.
 boolean isShadow()
          Check the shadow option of this text box.
 void setBorder(int border)
          Set the border around this text box.
 void setBorderColor(Color color)
          Set the border color.
 void setBorders(Insets borders)
          Set the individual border line styles.
 void setCornerSize(Dimension corner)
          Set the corner width and height for rounded rectangle shape.
 void setData(Object val)
          Set the data in object, it's used for binding.
 void setJustify(boolean justify)
          Set the line justify setting.
 void setPadding(Insets padding)
          Set box padding space.
 void setShadow(boolean shadow)
          Set the shadow option of this text box.
 void setShape(int shape)
          Set the textbox shape.
 void setText(String text)
          Set the text contained in this text element.
 void setTextAlignment(int align)
          Set the text alignment within the text box.
 void setTextID(String textID)
          Set the textID, which is used for i18n support.
 void setTextLens(TextLens text)
          Set the text contained in this text element.
 
Methods inherited from interface inetsoft.report.PainterElement
getAnchor, getHyperlink, getHyperlinkAreas, getLayout, getMargin, getPainter, getRotation, getSize, getWrapping, setAnchor, setHyperlink, setLayout, setMargin, setPainter, setRotation, setSize, setWrapping
 
Methods inherited from interface inetsoft.report.ReportElement
clone, getAlignment, getBackground, getCSSClass, getFont, getForeground, getFullName, getID, getIndent, getOnClick, getPreferredSize, getProperty, getPropertyNames, getScript, getSpacing, getTarget, getType, getUserObject, isHideOnPrint, isKeepWithNext, isVisible, setAlignment, setBackground, setContext, setCSSClass, setFont, setForeground, setFullName, setHideOnPrint, setID, setIndent, setKeepWithNext, setOnClick, setProperty, setScript, setSpacing, setTarget, setUserObject, setVisible
 
Methods inherited from interface inetsoft.report.HyperlinkSupport
getHyperlink, setHyperlink
 

Method Detail

setBorder

void setBorder(int border)
Set the border around this text box.

Parameters:
border - line style in StyleConstants, e.g. THIN_LINE.

getBorder

int getBorder()
Get the border around this text box.

Returns:
border line style.

setBorderColor

void setBorderColor(Color color)
Set the border color. If the border color is not set, the foreground color is used to draw the border.


getBorderColor

Color getBorderColor()
Get the border color.


setBorders

void setBorders(Insets borders)
Set the individual border line styles. This overrides the default border setting.

Parameters:
borders - line styles defined in StyleConstants, e.g. THIN_LINE.

getBorders

Insets getBorders()
Get the individual border line styles.

Returns:
border line style..

setShadow

void setShadow(boolean shadow)
Set the shadow option of this text box. If shadow is turned on, a drop shadow is added to the text box.


isShadow

boolean isShadow()
Check the shadow option of this text box.


setShape

void setShape(int shape)
Set the textbox shape. One of StyleConstants.BOX_RECTANGLE or StyleConstants.BOX_ROUNDED_RECTANGLE.

Parameters:
shape - textbox shape option.

getShape

int getShape()
Get the textbox shape.

Returns:
the textbox shape.

setCornerSize

void setCornerSize(Dimension corner)
Set the corner width and height for rounded rectangle shape.


getCornerSize

Dimension getCornerSize()
Get the corner width and height of rounded rectangle.


isJustify

boolean isJustify()
Get the line justify setting.

Returns:
true if lines are justified.

setJustify

void setJustify(boolean justify)
Set the line justify setting.

Parameters:
justify - true to justify lines.

getText

String getText()
Return the text in the text lens.


setText

void setText(String text)
Set the text contained in this text element.


setTextLens

void setTextLens(TextLens text)
Set the text contained in this text element.


getTextLens

TextLens getTextLens()
Return the text lens of this text element.


getTextAlignment

int getTextAlignment()
Get the text alignment.


setTextAlignment

void setTextAlignment(int align)
Set the text alignment within the text box.


getPadding

Insets getPadding()
Get box padding space.


setPadding

void setPadding(Insets padding)
Set box padding space.


getData

Object getData()
Get the data in object, it's used for binding.


setData

void setData(Object val)
Set the data in object, it's used for binding.


getTextID

String getTextID()
Get the textID, which is used for i18n support.


setTextID

void setTextID(String textID)
Set the textID, which is used for i18n support.


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