Style Intelligence v12.0

inetsoft.report
Interface PainterElement

All Superinterfaces:
Cloneable, HyperlinkSupport, ReportElement, Serializable
All Known Subinterfaces:
ButtonElement, ChartElement, CheckBoxElement, ChoiceElement, DateComboElement, FieldElement, ImageButtonElement, ListElement, RadioButtonElement, TextAreaElement, TextBoxElement, TextFieldElement

public interface PainterElement
extends ReportElement, HyperlinkSupport

A painter element is an element with fixed size. It can be anchored to the previous element. The painter element is the base class for chart, textbox, and image.


Field Summary
 
Fields inherited from interface inetsoft.report.ReportElement
AGGREGATE, AUTOSIZE, GROW, LOCAL_QUERY, QUERY, XNODEPATH
 
Method Summary
 Position getAnchor()
          Get the painter anchor (distance from last element and left of report).
 Hyperlink getHyperlink(Shape shape)
          Get the hyper link on this element for the specified area.
 Enumeration getHyperlinkAreas()
          Return the areas that have a hyperlink defined.
 int getLayout()
          Get the layout option of this element.
 Insets getMargin()
          Get the painter external space.
 Painter getPainter()
          Get the painter object.
 int getRotation()
          Get the rotation in degrees.
 Size getSize()
          Get the size of the element.
 int getWrapping()
          Get the wrapping style of this element.
 void setAnchor(Position anchor)
          Set painter anchor.
 void setHyperlink(Shape shape, Hyperlink link)
          Set the hyper link of this element for the specified area.
 void setLayout(int opt)
          Set the layout option.
 void setMargin(Insets margin)
          Set the painter external space.
 void setPainter(Painter painter)
          Set the painter object.
 void setRotation(int degree)
          Set the rotation degrees.
 void setSize(Size size)
          Set the size of the element.
 void setWrapping(int wrapping)
          Set the wrapping style of this element.
 
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

getPainter

Painter getPainter()
Get the painter object.


setPainter

void setPainter(Painter painter)
Set the painter object. The painter object is responsible for painting the painter element on a report.


getMargin

Insets getMargin()
Get the painter external space.


setMargin

void setMargin(Insets margin)
Set the painter external space.


setSize

void setSize(Size size)
Set the size of the element.

Parameters:
size - size in inches.

getSize

Size getSize()
Get the size of the element.

Returns:
size in inches.

setWrapping

void setWrapping(int wrapping)
Set the wrapping style of this element. Wrapping styles are defined in ReportSheet, e.g. ReportSheet.WRAP_BOTH. Wrappign style determines how other elements are positioned around a painter element. Wrapping is only performed in the painter is anchored.


getWrapping

int getWrapping()
Get the wrapping style of this element.


setLayout

void setLayout(int opt)
Set the layout option. Breakable or non-break. If the option is ReportSheet.PAINTER_BREAKABLE, the painter may be broken up across pages if the current page does not have enough space to accomodate the painter. Otherwise the painter is always drawn as one piece.


getLayout

int getLayout()
Get the layout option of this element.


getAnchor

Position getAnchor()
Get the painter anchor (distance from last element and left of report).


setAnchor

void setAnchor(Position anchor)
Set painter anchor. An anchor defines the distance of the painter to the left of the page, and the distance to the bottom of the last element (if anchor.y is positive), or distance to the top of the current line (if anchor.y is negative).


getRotation

int getRotation()
Get the rotation in degrees.


setRotation

void setRotation(int degree)
Set the rotation degrees. It can be 0, 90, or 270.


getHyperlink

Hyperlink getHyperlink(Shape shape)
Get the hyper link on this element for the specified area.


setHyperlink

void setHyperlink(Shape shape,
                  Hyperlink link)
Set the hyper link of this element for the specified area.


getHyperlinkAreas

Enumeration getHyperlinkAreas()
Return the areas that have a hyperlink defined. The hyperlink area is similar to imagemap in HTML. Each sub-area in a painter/image can have a different hyperlink.

Returns:
enumeration of Shape objects.

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