ActiveBagContent (JClic API)

java.lang.Object
- edu.xtec.jclic.boxes.ActiveBagContent

All Implemented Interfaces:

Domable
```
public class ActiveBagContent
extends Object
implements Domable
```
This class stores a collection of ActiveBoxContent objects, currently in a ArrayList, and provides methods to manage it. The two main members of ActiveBagContent are the Shaper, responsible of determining the position and shape of each ActiveBox based on it, and the BoxBase, that provides a common visual style.

Version:

13.09.09

Author:

Francesc Busquets (fbusquets@xtec.cat)

Field Summary

Fields
Modifier and Type	Field and Description
`protected ArrayList<ActiveBoxContent>`	`activeBoxContentArray`
`protected ActiveBoxContent`	`backgroundContent`
`BoxBase`	`bb`
`boolean`	`border`
`static String`	`BORDER`
`static String`	`CELL_HEIGHT`
`static String`	`CELL_WIDTH`
`static String`	`COLS`
`static String`	`COLUMNS`
`int`	`defaultIdValue`
`static String`	`ELEMENT_NAME`
`double`	`h`
`static String`	`IDS`
`static String`	`IMAGE`
`Image`	`img`
`String`	`imgName`
`int`	`nch`
`int`	`ncw`
`static String`	`ROWS`
`protected Shaper`	`shaper`
`double`	`w`

Constructor Summary

Constructors
Constructor and Description

ActiveBagContent(int ncw, int nch)

Constructors
Constructor and Description
`ActiveBagContent(int ncw, int nch)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addActiveBoxContent(ActiveBoxContent ab)`
`void`	`avoidAllIdsNull(int maxId)`
`void`	`checkCells()`
`void`	`copyStyleTo(ActiveBagContent abc)`
`void`	`deleteActiveBoxContentWith(int id, int item)`
`static ActiveBagContent`	`getActiveBagContent(Element e, MediaBag mediaBag)`
`ActiveBoxContent`	`getActiveBoxContent(int i)`
`ActiveBoxContent`	`getActiveBoxContentWith(int id, int item)`
`Element`	`getJDomElement()`
`int`	`getNumCells()`
`Shaper`	`getShaper()`
`double`	`getTotalHeight()`
`double`	`getTotalWidth()`
`boolean`	`hasImg()`
`int`	`indexOf(ActiveBoxContent cnt)`
`static ActiveBagContent`	`initNew(int ncw, int nch, int firstChar)`
`static ActiveBagContent`	`initNew(int ncw, int nch, int firstChar, boolean withIds, boolean withItems, int w, int h)`
`void`	`insertActiveBoxContentWith(int id, int item)`
`boolean`	`isEmpty()`
`static void`	`listReferences(Element e, Map<String,String> map)`
`void`	`prepareMedia(PlayStation ps)`
`void`	`setActiveBoxContentAt(ActiveBoxContent ab, int index)`
`void`	`setAllIdsTo(int id)`
`void`	`setBoxBase(BoxBase boxBase)`
`void`	`setIds(int[] ids)`
`void`	`setImgContent(MediaBagElement mbe, boolean roundSizes)`
`void`	`setImgContent(MediaBagElement mbe, Shaper sh)`
`void`	`setImgContent(MediaBagElement mbe, Shaper sh, boolean roundSizes)`
`void`	`setProperties(Element e, Object aux)`
`void`	`setShaper(Shaper sh)`
`void`	`setTextContent(String[] txt, int setNcw, int setNch)`
`int`	`testCellContents()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

img
```
public Image img
```

imgName
```
public String imgName
```

ncw
```
public int ncw
```

nch
```
public int nch
```

w
```
public double w
```

h
```
public double h
```

border
```
public boolean border
```

bb
```
public BoxBase bb
```

shaper
```
protected Shaper shaper
```

backgroundContent

protected ActiveBoxContent backgroundContent

activeBoxContentArray

protected ArrayList<ActiveBoxContent> activeBoxContentArray

defaultIdValue
```
public int defaultIdValue
```

ELEMENT_NAME

public static final String ELEMENT_NAME

See Also:: Constant Field Values

ROWS
```
public static final String ROWS
```
See Also:
Constant Field Values

COLUMNS
```
public static final String COLUMNS
```
See Also:
Constant Field Values

COLS
```
public static final String COLS
```
See Also:
Constant Field Values

CELL_WIDTH
```
public static final String CELL_WIDTH
```
See Also:
Constant Field Values

CELL_HEIGHT
```
public static final String CELL_HEIGHT
```
See Also:
Constant Field Values

BORDER
```
public static final String BORDER
```
See Also:
Constant Field Values

IMAGE
```
public static final String IMAGE
```
See Also:
Constant Field Values

IDS
```
public static final String IDS
```
See Also:
Constant Field Values

Constructor Detail

ActiveBagContent

public ActiveBagContent(int ncw,
                int nch)

Method Detail

initNew

public static ActiveBagContent initNew(int ncw,
                       int nch,
                       int firstChar)

initNew

public static ActiveBagContent initNew(int ncw,
                       int nch,
                       int firstChar,
                       boolean withIds,
                       boolean withItems,
                       int w,
                       int h)

checkCells
```
public void checkCells()
```

getJDomElement
```
public Element getJDomElement()
```
Specified by:

getJDomElement in interface Domable

testCellContents
```
public int testCellContents()
```

getActiveBagContent

public static ActiveBagContent getActiveBagContent(Element e,
                                   MediaBag mediaBag)
                                            throws Exception

Throws:: Exception

setProperties

public void setProperties(Element e,
                 Object aux)
                   throws Exception

Specified by:: setProperties in interface Domable
Throws:: Exception

listReferences

public static void listReferences(Element e,
                  Map<String,String> map)

getShaper
```
public Shaper getShaper()
```

setShaper
```
public void setShaper(Shaper sh)
```

addActiveBoxContent

public void addActiveBoxContent(ActiveBoxContent ab)

getActiveBoxContent

public ActiveBoxContent getActiveBoxContent(int i)

getActiveBoxContentWith

public ActiveBoxContent getActiveBoxContentWith(int id,
                                       int item)

deleteActiveBoxContentWith

public void deleteActiveBoxContentWith(int id,
                              int item)

insertActiveBoxContentWith

public void insertActiveBoxContentWith(int id,
                              int item)

indexOf

public int indexOf(ActiveBoxContent cnt)

setActiveBoxContentAt

public void setActiveBoxContentAt(ActiveBoxContent ab,
                         int index)

setImgContent

public void setImgContent(MediaBagElement mbe,
                 boolean roundSizes)
                   throws Exception

Throws:: Exception

setImgContent

public void setImgContent(MediaBagElement mbe,
                 Shaper sh)
                   throws Exception

Throws:: Exception

setImgContent

public void setImgContent(MediaBagElement mbe,
                 Shaper sh,
                 boolean roundSizes)
                   throws Exception

Throws:: Exception

setTextContent

public void setTextContent(String[] txt,
                  int setNcw,
                  int setNch)

hasImg
```
public boolean hasImg()
```

getTotalWidth
```
public double getTotalWidth()
```

getTotalHeight
```
public double getTotalHeight()
```

getNumCells
```
public int getNumCells()
```

isEmpty
```
public boolean isEmpty()
```

prepareMedia

public void prepareMedia(PlayStation ps)

setBoxBase

public void setBoxBase(BoxBase boxBase)

setIds
```
public void setIds(int[] ids)
```

setAllIdsTo
```
public void setAllIdsTo(int id)
```

avoidAllIdsNull

public void avoidAllIdsNull(int maxId)

copyStyleTo

public void copyStyleTo(ActiveBagContent abc)

Class ActiveBagContent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

img

imgName

ncw

nch

w

h

border

bb

shaper

backgroundContent

activeBoxContentArray

defaultIdValue

ELEMENT_NAME

ROWS

COLUMNS

COLS

CELL_WIDTH

CELL_HEIGHT

BORDER

IMAGE

IDS

Constructor Detail

ActiveBagContent

Method Detail

initNew

initNew

checkCells

getJDomElement

testCellContents

getActiveBagContent

setProperties

listReferences

getShaper

setShaper

addActiveBoxContent

getActiveBoxContent

getActiveBoxContentWith

deleteActiveBoxContentWith

insertActiveBoxContentWith

indexOf

setActiveBoxContentAt

setImgContent

setImgContent

setImgContent

setTextContent

hasImg

getTotalWidth

getTotalHeight

getNumCells

isEmpty

prepareMedia

setBoxBase

setIds

setAllIdsTo

avoidAllIdsNull

copyStyleTo