class: LayoutElement

public class: LayoutElement
Author: vmakarenko (initial creation)
Project: Phase: 1.0; Status: Proposed; Version: $Revision: 1142 $ $LastChangedDate: 2008-10-29 10:; Complexity: 1
Dates: Created: 16.07.2009 15:12:19; Modified: 16.07.2009 15:12:19;
Flags: Active: false; IsRoot: false; IsLeaf: false;
Extension Points:
UUID: {57882DAF-4108-47b8-9EE1-FBCF83833A09}
An instance of this class represents a layout element
 

Goto: Custom Properties, Fields, Methods

See also: Parameters, ReportingGUI, ReportingGUI, ReportingGUI

Appears in: data

Connections
 
Custom Properties
 
LayoutElement Attributes
Attribute Details
public static const String
  DEFAULT_POSITION_NAME
Initial: "default"
private List
  elements
Notes: elements of LE at current position (ordered list of LE)
private String
  func
Notes: Name of applicable function
public boolean
  hasName
Notes: shows whether LE has user defined name
private String
  id
Notes: internal uniq id
private String
  name
Notes: Name of LE;
private Parameters
  parameters
Notes: parameters of LE at current position
private String
  position
Notes: indicator of position for repeatable le
private HashMap
  positionBundle
Notes: parameters and elements will be added to position bundle according to position
private String
  ref
Notes: String value of @ref
private String
  repeatable
Notes: indicator of repeatable data
 
LayoutElement Methods
Operation Details
public
_isRepeatable():boolean
Sequential
public
addElement(
   LayoutElement le):void
Sequential
public
addPositionBundle():void
Sequential
Tags: throws=CitationStyleManagerException
Notes: Takes <code>elements</code> and <code>parameters</code> and adds them to PositionBundle according to <code>position</code>. Resets <code>elements</code> and <code>parameters</code>.
public
clone():Object
Sequential
public
fillEmptyNames(
   String prefix):void
Sequential
Notes: Walks around layoutElement and sets names according to position in tree for empty names
public
generateIDs(
   String prefix):void
Sequential
Notes: Walk around completet collection and generate uniq ids for layout elements
public static
getDigesterRules(
   Digester dig,
   String root):Digester
Sequential
Notes: Digester rules for LayoutElement
@return
public
getDomElement(
   Document d,
   String root):Element
Sequential
public
getDomElement(
   Document d):Element
Sequential
public
getElementById(
   String id):LayoutElement
Sequential
Notes: Get element by uniqal <code>id</code>
@return LayoutElement or null
public
getElementByName(
   String name):LayoutElement
Sequential
Notes: Get element by <code>name</code>
@return LayoutElement or null
public
getElements():List
Sequential
public
getElementsAt(
   String position):ArrayList
Sequential
public
getElementsAtDefault():ArrayList
Sequential
public
getFunc():String
Sequential
public
getId():String
Sequential
public
getName():String
Sequential
public
getParameters():Parameters
Sequential
public
getParametersAt(
   String position):Parameters
Sequential
public
getParametersAtDefault():Parameters
Sequential
public
getPosition():String
Sequential
public
getPositionBundle():HashMap
Sequential
public
getPositionBundleAt(
   String position):HashMap
Sequential
Notes: Returns a <code>positionBundle</code> according to <code>position</code>
@return HashMap
public
getPositionBundleAtDefault():HashMap
Sequential
Notes: Returns a <code>positionBundle</code> at <code>DEFAULT_POSITION_NAME</code>
@param position - a position key
@return HashMap
public
getRef():String
Sequential
public
getRepeatable():String
Sequential
public
hasElements():boolean
Sequential
public
hasElementsAtDefault():boolean
Sequential
public
hasPositionBundle():boolean
Sequential
public
LayoutElement():
Sequential
public static
main(
   String[] args):void
Sequential
Tags: throws=IOException,CitationStyleManagerException
public
setDefault():void
Sequential
public
setElements(
   List elements):void
Sequential
public
setFunc(
   String func):void
Sequential
public
setId(
   String id):void
Sequential
public
setName(
   String name):void
Sequential
public
setParameters(
   Parameters parameters):void
Sequential
public
setPosition(
   String position):void
Sequential
public
setPositionBundle(
   HashMap newPositionBundle):void
Sequential
public
setRef(
   String ref):void
Sequential
public
setRepeatable(
   String repeatable):void
Sequential
public
toString():String
Sequential