How to use

bibliothek.gui.dock.layout.DockLayoutInfo

constructor

@SuppressWarnings("unchecked")
public PredefinedLayout getLayout( DockElement element, Map<Dockable, Integer> children ) {
  if( shouldLayout( element )){
    String factoryId = UNKNOWN + PredefinedDockSituation.super.getID( element );
    DockFactory<DockElement,?,Object> factory = (DockFactory<DockElement,?,Object>)getFactory( factoryId );
    if( factory == null )
      throw new IllegalStateException( "Missing factory: " + factoryId );
    Object data = factory.getLayout( element, children );
    DockLayout<Object> layout = new DockLayout<Object>( factoryId, data );
    return new PredefinedLayout( elementToString.get( element ), new DockLayoutInfo( layout ));    
  }
  else{
    return new PredefinedLayout( elementToString.get( element ), new DockLayoutInfo() );
  }
}

@SuppressWarnings("unchecked")
public PredefinedLayout getLayout( DockElement element, Map<Dockable, Integer> children ) {
  if( shouldLayout( element )){
    String factoryId = UNKNOWN + PredefinedDockSituation.super.getID( element );
    DockFactory<DockElement,?,Object> factory = (DockFactory<DockElement,?,Object>)getFactory( factoryId );
    if( factory == null )
      throw new IllegalStateException( "Missing factory: " + factoryId );
    Object data = factory.getLayout( element, children );
    DockLayout<Object> layout = new DockLayout<Object>( factoryId, data );
    return new PredefinedLayout( elementToString.get( element ), new DockLayoutInfo( layout ));    
  }
  else{
    return new PredefinedLayout( elementToString.get( element ), new DockLayoutInfo() );
  }
}

@SuppressWarnings("unchecked")
public PredefinedLayout getPerspectiveLayout( PerspectiveElement element, Map<PerspectiveDockable, Integer> children ){
  if( perspective == null ){
    throw new IllegalStateException( "the perspective of this factory is not set, meaning this factory cannot be used handling perspective dependent tasks" );
  }
  
  DockLayoutInfo info;
  
  if( shouldLayout( element, perspective )){
    String factoryId = UNKNOWN + PredefinedDockSituation.super.getID( element );
    DockFactory factory = getFactory( factoryId );
    if( factory == null )
      throw new IllegalStateException( "Missing factory: " + factoryId );
    Object data = factory.getPerspectiveLayout( element, children );
    DockLayout<Object> layout = new DockLayout<Object>( factoryId, data );
    info = new DockLayoutInfo( layout );
  }
  else{
    info = new DockLayoutInfo();
  }
  
  String key = perspective.get( element );
  if( key == null ){
    throw new IllegalStateException( "Expected a key for an element, the element should be known to the perspective, otherwise this method would not have been called: '" + element +"'" );
  }
  
  return new PredefinedLayout( key, info );
}

@SuppressWarnings("unchecked")
public PredefinedLayout getPerspectiveLayout( PerspectiveElement element, Map<PerspectiveDockable, Integer> children ){
  if( perspective == null ){
    throw new IllegalStateException( "the perspective of this factory is not set, meaning this factory cannot be used handling perspective dependent tasks" );
  }
  
  DockLayoutInfo info;
  
  if( shouldLayout( element, perspective )){
    String factoryId = UNKNOWN + PredefinedDockSituation.super.getID( element );
    DockFactory factory = getFactory( factoryId );
    if( factory == null )
      throw new IllegalStateException( "Missing factory: " + factoryId );
    Object data = factory.getPerspectiveLayout( element, children );
    DockLayout<Object> layout = new DockLayout<Object>( factoryId, data );
    info = new DockLayoutInfo( layout );
  }
  else{
    info = new DockLayoutInfo();
  }
  
  String key = perspective.get( element );
  if( key == null ){
    throw new IllegalStateException( "Expected a key for an element, the element should be known to the perspective, otherwise this method would not have been called: '" + element +"'" );
  }
  
  return new PredefinedLayout( key, info );
}

return new PredefinedLayout( preload, new DockLayoutInfo() );
return new PredefinedLayout( preload, new DockLayoutInfo( xdelegate ));
return new PredefinedLayout( preload, new DockLayoutInfo( layout ) );

return new PredefinedLayout( preload, new DockLayoutInfo() );
return new PredefinedLayout( preload, new DockLayoutInfo( xdelegate ));
return new PredefinedLayout( preload, new DockLayoutInfo( layout ) );

info = new DockLayoutInfo();
    BackupFactoryData<Object> data = (BackupFactoryData<Object>)backup.read( in, placeholders );
    if( data != null && data.getData() != null ){
      info = new DockLayoutInfo( new DockLayout<Object>( factoryId, data.getData() ));
    info = new DockLayoutInfo( out.toByteArray() );
  Object delegate = factory.read( in, placeholders );
  if( delegate != null ){
    info = new DockLayoutInfo( new DockLayout<Object>( factoryId, delegate ));

  info = new DockLayoutInfo( new DockLayout<Object>( factoryId, data ));
  info.setPlaceholder( placeholder );
info = new DockLayoutInfo( entry );
info.setPlaceholder( placeholder );
info = new DockLayoutInfo( new DockLayout<Object>( factoryId, data ) );
info.setPlaceholder( placeholder );

info = new DockLayoutInfo();
    BackupFactoryData<Object> data = (BackupFactoryData<Object>)backup.read( in, placeholders );
    if( data != null && data.getData() != null ){
      info = new DockLayoutInfo( new DockLayout<Object>( factoryId, data.getData() ));
    info = new DockLayoutInfo( out.toByteArray() );
  Object delegate = factory.read( in, placeholders );
  if( delegate != null ){
    info = new DockLayoutInfo( new DockLayout<Object>( factoryId, delegate ));

  BackupFactoryData<Object> data = (BackupFactoryData<Object>)backup.read( in, getPlaceholderStrategy() );
  if( data != null && data.getData() != null ){
    info = new DockLayoutInfo( new DockLayout<Object>( factoryId, data.getData() ));
Object delegate = factory.read( in, getPlaceholderStrategy() );
if( delegate != null ){
  info = new DockLayoutInfo( new DockLayout<Object>( factoryId, delegate ));

  BackupFactoryData<Object> data = (BackupFactoryData<Object>)backup.read( in, getPlaceholderStrategy() );
  if( data != null && data.getData() != null ){
    info = new DockLayoutInfo( new DockLayout<Object>( factoryId, data.getData() ));
Object delegate = factory.read( in, getPlaceholderStrategy() );
if( delegate != null ){
  info = new DockLayoutInfo( new DockLayout<Object>( factoryId, delegate ));

if( match != null ){
  DockLayout<?> newLayout = new DockLayout<MultipleCDockable>( REPLACEMENT_FACTORY_ID, match );
  DockLayoutInfo newInfo = new DockLayoutInfo( newLayout );
  newInfo.setLocation( info.getLocation() );
  info = newInfo;

DockLayoutInfo info = new DockLayoutInfo( layout );
PerspectiveDockable dockable = element.asDockable();
if( dockable != null ){

if( match != null ){
  DockLayout<?> newLayout = new DockLayout<MultipleCDockable>( REPLACEMENT_FACTORY_ID, match );
  DockLayoutInfo newInfo = new DockLayoutInfo( newLayout );
  newInfo.setLocation( info.getLocation() );
  info = newInfo;

DockLayoutInfo info = new DockLayoutInfo( layout );
info.setPlaceholder( getPlaceholder( element ) );
return new DockLayoutComposition( info, adjacent, children, ignore );

Object data = factory.read( element, intermediatePlaceholders );
if( data != null ){
  layout = new DockLayoutInfo( new DockLayout<Object>( factoryId, data ) );
  layout.setPlaceholder( placeholder );
  Object data = missingFactory.readXML( getFactoryID( factoryId ), element );
  if( data != null ){
    layout = new DockLayoutInfo( new DockLayout<Object>( factoryId, data ) );
    layout.setPlaceholder( placeholder );
  layout = new DockLayoutInfo( element );
  layout.setPlaceholder( placeholder );

@Override
protected DockLayoutInfo fillMissing( DockLayoutInfo info ) {
  DockLayout<?> layout = info.getDataLayout();
  if( KNOWN.equals( layout.getFactoryID() )){
    PredefinedLayout preloaded = (PredefinedLayout)layout.getData();
    DockLayoutInfo delegate = preloaded.getDelegate();
    DockLayoutInfo newDelegate = null;
    if( delegate.getKind() == DockLayoutInfo.Data.BYTE ){
      newDelegate = fillMissingStream( preloaded );
    }
    else if( delegate.getKind() == DockLayoutInfo.Data.XML ){
      newDelegate = fillMissingXML( preloaded );
    }
    if( newDelegate != null ){
      info = new DockLayoutInfo( new DockLayout<PredefinedLayout>( 
          KNOWN, new PredefinedLayout( preloaded.getPredefined(), newDelegate )));
    }
  }
  return info;
}

@Override
protected DockLayoutInfo fillMissing( DockLayoutInfo info ) {
  DockLayout<?> layout = info.getDataLayout();
  if( KNOWN.equals( layout.getFactoryID() )){
    PredefinedLayout preloaded = (PredefinedLayout)layout.getData();
    DockLayoutInfo delegate = preloaded.getDelegate();
    DockLayoutInfo newDelegate = null;
    if( delegate.getKind() == DockLayoutInfo.Data.BYTE ){
      newDelegate = fillMissingStream( preloaded );
    }
    else if( delegate.getKind() == DockLayoutInfo.Data.XML ){
      newDelegate = fillMissingXML( preloaded );
    }
    if( newDelegate != null ){
      info = new DockLayoutInfo( new DockLayout<PredefinedLayout>( 
          KNOWN, new PredefinedLayout( preloaded.getPredefined(), newDelegate )));
    }
  }
  return info;
}

/**
 * Tries to read the xml data in <code>layout</code>.
 * @param layout the layout to read
 * @return either a new info or <code>null</code> if the data could
 * not be read
 */
@SuppressWarnings("unchecked")
private DockLayoutInfo fillMissingXML( PredefinedLayout layout ){
  XElement xdelegate = layout.getDelegate().getDataXML();
  String factoryId = xdelegate.getString( "id" );
  Object delegate = null;
  DockFactory<DockElement,?,Object> factory = (DockFactory<DockElement,?,Object>)getFactory( factoryId );
  if( factory == null ){
    DockFactory<?,?,BackupFactoryData<?>> backup = getBackup( factoryId );
    if( backup != null ){
      BackupFactoryData<Object> data = (BackupFactoryData<Object>)backup.read( xdelegate, getPlaceholderStrategy() );
      if( data != null )
        delegate = data.getData();
    }
  }
  else{
    delegate = factory.read( xdelegate, getPlaceholderStrategy() );
  }
  if( delegate == null ){
    return null;
  }
  
  return new DockLayoutInfo( new DockLayout<Object>( factoryId, delegate ) );
}

/**
 * Tries to read the xml data in <code>layout</code>.
 * @param layout the layout to read
 * @return either a new info or <code>null</code> if the data could
 * not be read
 */
@SuppressWarnings("unchecked")
private DockLayoutInfo fillMissingXML( PredefinedLayout layout ){
  XElement xdelegate = layout.getDelegate().getDataXML();
  String factoryId = xdelegate.getString( "id" );
  Object delegate = null;
  DockFactory<DockElement,?,Object> factory = (DockFactory<DockElement,?,Object>)getFactory( factoryId );
  if( factory == null ){
    DockFactory<?,?,BackupFactoryData<?>> backup = getBackup( factoryId );
    if( backup != null ){
      BackupFactoryData<Object> data = (BackupFactoryData<Object>)backup.read( xdelegate, getPlaceholderStrategy() );
      if( data != null )
        delegate = data.getData();
    }
  }
  else{
    delegate = factory.read( xdelegate, getPlaceholderStrategy() );
  }
  if( delegate == null ){
    return null;
  }
  
  return new DockLayoutInfo( new DockLayout<Object>( factoryId, delegate ) );
}